core/behaviour/src/net/sf/cotta/io/InputTest.java core/behaviour/src/net/sf/cotta/io/OutputTest.java @@ -1,13 +1,11 @@ package net.sf.cotta.io; -import net.sf.cotta.TIoException; import net.sf.cotta.TestCase; import org.jmock.Expectations; import org.jmock.Mockery; import java.io.ByteArrayOutputStream; import java.io.IOException; -import java.io.OutputStream; public class OutputManagerTest extends TestCase { public Mockery context = new Mockery(); @@ -48,27 +46,4 @@ public class OutputManagerTest extends TestCase { }); context.assertIsSatisfied(); } - - public void testWithStaticFactoryMethod() throws TIoException { - final OutputStream stream = new ByteArrayOutputStream(); - OutputManager.with(stream).write(new OutputProcessor() { - public void process(OutputManager manager) throws IOException { - ensure.that(manager.outputStream()).sameAs(stream); - } - }); - } - - public void testWithStaticFactorySupportsPath() throws TIoException { - OutputStream stream = new ByteArrayOutputStream(); - OutputManager.with(stream).write(new OutputProcessor() { - public void process(OutputManager manager) throws IOException { - try { - manager.writer("aoeuaoeuaoeu"); - fail("should have thrown exception for wrong encoding"); - } catch (TIoException e) { - ensure.that(e).message().contains("output stream"); - } - } - }); - } } core/behaviour/src/net/sf/cotta/io/OutputManagerTest.java @@ -36,7 +36,7 @@ public class ProductInfoTest extends TestCase { ensure.that(productInfo.title()).eq("Cotta"); ensure.that(productInfo.vendor()).eq("SourceForge Cotta"); ensure.that(productInfo.url()).eq("http://cotta.sourceforge.net"); - ensure.that(productInfo.version().value()).eq("2.0.0"); + ensure.that(productInfo.version().value()).eq("2.1.0"); ensure.that(productInfo.version().build()).notNull(); } core/behaviour/src/net/sf/cotta/utils/ProductInfoTest.java @@ -1,5 +1,5 @@ Implementation-Title: Cotta -Implementation-Version: 2.0.0 +Implementation-Version: 2.1.0 Implementation-Build: 79 Implementation-Vendor: SourceForge Cotta Implementation-Vendor-Id: net.sf.cotta core/src/META-INF/MANIFEST.MF @@ -41,8 +41,7 @@ public class TDirectoryListing implements Iterable<TEntry> { return list; } - @SuppressWarnings({"unchecked"}) - private void addFiles(ArrayList entries, List<TPath> files) { + private void addFiles(ArrayList<? super TFile> entries, List<TPath> files) { for (TPath path : files) { TFile file = factory.file(path); if (fileFilter.accept(file)) { @@ -51,8 +50,7 @@ public class TDirectoryListing implements Iterable<TEntry> { } } - @SuppressWarnings({"unchecked"}) - private void addDirs(ArrayList entries, List<TPath> dirs) { + private void addDirs(ArrayList<? super TDirectory> entries, List<TPath> dirs) { for (TPath path : dirs) { TDirectory dir = factory.dir(path); if (directoryFilter.accept(dir)) { core/src/net/sf/cotta/TDirectoryListing.java @@ -118,7 +118,13 @@ public class TFile extends TEntry { }; } - private FileChannel inputChannel() throws TIoException { + /** + * Creates the input channel for the file + * + * @return FileChannel for input + * @throws TIoException error in creating the input channel + */ + public FileChannel inputChannel() throws TIoException { return filesystem().createInputChannel(path); } @@ -237,7 +243,7 @@ public class TFile extends TEntry { * @throws TIoException error in reading the file */ public void read(final InputProcessor processor) throws TIoException { - InputManager.with(inputStreamFactory()).read(processor); + Input.with(inputStreamFactory()).read(processor); } /** @@ -247,15 +253,15 @@ public class TFile extends TEntry { * @throws TIoException error in reading the file */ public void read(final LineProcessor lineProcessor) throws TIoException { - InputManager.with(inputStreamFactory()).readLines(lineProcessor); + Input.with(inputStreamFactory()).readLines(lineProcessor); } public void append(final OutputProcessor processor) throws TIoException { - OutputManager.with(outputStreamFactory(OutputMode.APPEND), null).write(processor); + Output.with(outputStreamFactory(OutputMode.APPEND), null).write(processor); } public void write(final OutputProcessor processor) throws TIoException { - OutputManager.with(outputStreamFactory(OutputMode.OVERWRITE), null).write(processor); + Output.with(outputStreamFactory(OutputMode.OVERWRITE), null).write(processor); } /** core/src/net/sf/cotta/TFile.java @@ -1,10 +1,16 @@ package net.sf.cotta.io; import net.sf.cotta.TIoException; +import net.sf.cotta.TPath; import java.io.BufferedReader; import java.io.IOException; +import java.io.InputStream; +import java.nio.channels.FileChannel; +/** + * Input processing class used to expose the API in the right context + */ public class Input { private InputManager manager; @@ -40,4 +46,62 @@ public class Input { } }); } + + /** + * A static factory to create an Input instance for processing the input stream with system default encoding + * + * @param stream the input stream to process + * @return The Input instance + */ + public static Input with(final InputStream stream) { + return with(stream, null); + } + + /** + * A static factory to create an Input instance for processing the input stream with the given encoding when creating readers + * + * @param stream the input stream to process + * @param encoding encoding used when creating readers + * @return The Input instance + */ + public static Input with(final InputStream stream, String encoding) { + return with(new InputStreamFactory() { + public InputStream inputStream() throws TIoException { + return stream; + } + + public FileChannel inputChannel() throws TIoException { + throw new UnsupportedOperationException(); + } + + public TPath path() { + return TPath.parse("/input stream"); + } + + }, encoding); + } + + /** + * A static factory to create an Input instance for processing the input stream + * to be created by the InputStreamFactory with system default encoding + * + * @param streamFactory input stream factory + * @return the Input instance + */ + public static Input with(InputStreamFactory streamFactory) { + return with(streamFactory, null); + } + + /** + * A static factory to create an Input instance for processing the input stream + * to be created by the InputStreamFactory with provided encoding + * + * @param streamFactory input stream factory + * @param encoding encoding used to create readers + * @return the Input instance + */ + public static Input with(InputStreamFactory streamFactory, String encoding) { + final InputManager manager = new InputManager(streamFactory, encoding); + return new Input(manager); + } } core/src/net/sf/cotta/io/Input.java @@ -11,6 +11,10 @@ import java.security.AccessController; import java.security.PrivilegedAction; import java.util.ArrayList; +/** + * InputManager for input resource management. This class is to be used + * through {@link net.sf.cotta.io.Input} + */ public class InputManager extends ResourceManager<InputProcessor> { private InputFactory inputFactory; @@ -70,17 +74,16 @@ public class InputManager extends ResourceManager<InputProcessor> { * * @param buffer the buffer to clean up */ + @SuppressWarnings("unchecked") public void clean(final MappedByteBuffer buffer) { AccessController.doPrivileged(new PrivilegedAction() { public Object run() { try { Method getCleanerMethod = buffer.getClass - ().getMethod("cleaner", - new Class[0]); + ().getMethod("cleaner"); getCleanerMethod.setAccessible(true); sun.misc.Cleaner cleaner = - (sun.misc.Cleaner) getCleanerMethod.invoke(buffer, new Object - [0]); + (sun.misc.Cleaner) getCleanerMethod.invoke(buffer); cleaner.clean(); } catch (Exception e) { e.printStackTrace(); @@ -95,9 +98,11 @@ public class InputManager extends ResourceManager<InputProcessor> { * * @param stream the input stream to process * @return The Input instance + * @deprecated Moved to Input */ + @Deprecated public static Input with(final InputStream stream) { - return with(stream, null); + return Input.with(stream); } /** @@ -106,22 +111,11 @@ public class InputManager extends ResourceManager<InputProcessor> { * @param stream the input stream to process * @param encoding encoding used when creating readers * @return The Input instance + * @deprecated Moved to Input */ + @Deprecated public static Input with(final InputStream stream, String encoding) { - return with(new InputStreamFactory() { - public InputStream inputStream() throws TIoException { - return stream; - } - - public FileChannel inputChannel() throws TIoException { - throw new UnsupportedOperationException(); - } - - public TPath path() { - return TPath.parse("/input stream"); - } - - }, encoding); + return Input.with(stream, encoding); } /** @@ -130,9 +124,11 @@ public class InputManager extends ResourceManager<InputProcessor> { * * @param streamFactory input stream factory * @return the Input instance + * @deprecated Moved to Input */ + @Deprecated public static Input with(InputStreamFactory streamFactory) { - return with(streamFactory, null); + return Input.with(streamFactory); } /** @@ -142,10 +138,11 @@ public class InputManager extends ResourceManager<InputProcessor> { * @param streamFactory input stream factory * @param encoding encoding used to create readers * @return the Input instance + * @deprecated Moved to Input */ + @Deprecated public static Input with(InputStreamFactory streamFactory, String encoding) { - final InputManager manager = new InputManager(streamFactory, encoding); - return new Input(manager); + return Input.with(streamFactory, encoding); } } core/src/net/sf/cotta/io/InputManager.java @@ -1,6 +1,9 @@ package net.sf.cotta.io; import net.sf.cotta.TIoException; +import net.sf.cotta.TPath; + +import java.io.OutputStream; public class Output { private OutputManager manager; @@ -12,4 +15,54 @@ public class Output { public void write(OutputProcessor processor) throws TIoException { manager.open(processor); } + + /** + * Creates the output instance with the given output stream and use system encoding + * + * @param stream output stream + * @return output instance + */ + public static Output with(final OutputStream stream) { + return with(stream, null); + } + + /** + * Create the output instance with the given output steram and default encoding + * + * @param stream output stream + * @param defaultEncoding default encoding for creating the writers + * @return output instance + */ + public static Output with(final OutputStream stream, String defaultEncoding) { + return with(new OutputStreamFactory() { + public TPath path() { + return TPath.parse("/output stream"); + } + + public OutputStream outputStream() throws TIoException { + return stream; + } + }, defaultEncoding); + } + + /** + * Create the output instance with the stream factory and use system encoding + * + * @param streamFactory stream factory + * @return output instance + */ + public static Output with(OutputStreamFactory streamFactory) { + return with(streamFactory, null); + } + + /** + * Creates the output instance + * + * @param streamFactory output stream factory + * @param defaultEncoding default encoding for the writers + * @return output instance + */ + public static Output with(OutputStreamFactory streamFactory, String defaultEncoding) { + return new Output(new OutputManager(streamFactory, defaultEncoding)); + } } core/src/net/sf/cotta/io/Output.java @@ -6,6 +6,9 @@ import net.sf.cotta.TPath; import java.io.*; import java.util.ArrayList; +/** + * Output resource management class to be used through {@link net.sf.cotta.io.Output} + */ public class OutputManager extends ResourceManager<OutputProcessor> { private OutputFactory output; @@ -57,9 +60,11 @@ public class OutputManager extends ResourceManager<OutputProcessor> { * * @param stream output stream * @return output instance + * @deprecated moved to Output */ + @Deprecated public static Output with(final OutputStream stream) { - return with(stream, null); + return Output.with(stream); } /** @@ -68,17 +73,11 @@ public class OutputManager extends ResourceManager<OutputProcessor> { * @param stream output stream * @param defaultEncoding default encoding for creating the writers * @return output instance + * @deprecated moved to Output */ + @Deprecated public static Output with(final OutputStream stream, String defaultEncoding) { - return with(new OutputStreamFactory() { - public TPath path() { - return TPath.parse("/output stream"); - } - - public OutputStream outputStream() throws TIoException { - return stream; - } - }, defaultEncoding); + return Output.with(stream, defaultEncoding); } /** @@ -86,9 +85,11 @@ public class OutputManager extends ResourceManager<OutputProcessor> { * * @param streamFactory stream factory * @return output instance + * @deprecated moved to Output */ + @Deprecated public static Output with(OutputStreamFactory streamFactory) { - return with(streamFactory, null); + return Output.with(streamFactory); } /** @@ -97,8 +98,10 @@ public class OutputManager extends ResourceManager<OutputProcessor> { * @param streamFactory output stream factory * @param defaultEncoding default encoding for the writers * @return output instance + * @deprecated */ + @Deprecated public static Output with(OutputStreamFactory streamFactory, String defaultEncoding) { - return new Output(new OutputManager(streamFactory, defaultEncoding)); + return Output.with(streamFactory, defaultEncoding); } } core/src/net/sf/cotta/io/OutputManager.java @@ -9,6 +9,12 @@ import java.util.ArrayList; import java.util.Collections; import java.util.List; +/** + * resource manager that handles the resource management. This class is to + * be used through its sub-classes + * + * @param <P> The processor to be used for call back + */ abstract public class ResourceManager<P> { private List<Closeable> resourceList; @@ -24,7 +30,7 @@ abstract public class ResourceManager<P> { resourceList.add(resource); } - public void open(P processor) throws TIoException { + protected void open(P processor) throws TIoException { boolean errorOccurred = true; try { process(processor); core/src/net/sf/cotta/io/ResourceManager.java @@ -39,14 +39,21 @@ public class TestLoader { Class<? extends TestCase> testClass; try { Class<?> loadedClass = Class.forName(name); - //noinspection unchecked - testClass = (Class<? extends TestCase>) loadedClass; + testClass = checkAndCast(loadedClass); } catch (ClassNotFoundException e) { throw new RuntimeException(e.getMessage(), e); } return testClass; } + @SuppressWarnings({"unchecked"}) + private Class<? extends TestCase> checkAndCast(Class<?> loadedClass) { + if (TestCase.class.isAssignableFrom(loadedClass)) { + return (Class<TestCase>) loadedClass; + } + throw new RuntimeException(loadedClass + " is not a sub-class of TestCase"); + } + private ClassPathEntryProcessor collectNames() { return new ClassPathEntryProcessor() { public void process(TDirectory directory) throws TIoException { core/src/net/sf/cotta/test/TestLoader.java @@ -157,8 +157,8 @@ <component name="JavacSettings"> <option name="DEBUGGING_INFO" value="true" /> <option name="GENERATE_NO_WARNINGS" value="false" /> - <option name="DEPRECATION" value="true" /> - <option name="ADDITIONAL_OPTIONS_STRING" value="" /> + <option name="DEPRECATION" value="false" /> + <option name="ADDITIONAL_OPTIONS_STRING" value="-Xlint:unchecked" /> <option name="MAXIMUM_HEAP_SIZE" value="128" /> </component> <component name="JavadocGenerationManager"> cotta.ipr @@ -105,7 +105,7 @@ public class TestFtpServerFileSystem implements FileSystem { public ReadableByteChannel readFile(String filename, long position, Session userSession) throws FailedActionException { try { - return Channels.newChannel(pathToFile(filename).io().inputStream()); + return Channels.newChannel(pathToFile(filename).inputStream()); } catch (TIoException e) { throw reportError(e); } @@ -113,7 +113,7 @@ public class TestFtpServerFileSystem implements FileSystem { public WritableByteChannel saveFile(String filename, boolean append, Session userSession) throws FailedActionException { try { - return Channels.newChannel(pathToFile(filename).io().outputStream(append ? OutputMode.APPEND : OutputMode.OVERWRITE)); + return Channels.newChannel(pathToFile(filename).outputStream(append ? OutputMode.APPEND : OutputMode.OVERWRITE)); } catch (TIoException e) { throw reportError(e); } ftp/behaviour/src/net/sf/cotta/ftp/TestFtpServerFileSystem.java core/behaviour/src/net/sf/cotta/io/InputManagerTest.java aa28a10def663e0daf3ade1c44b9961aa2a5abab wolfdancer wolfdancer@gmail.com http://github.com/wolfdancer/cotta/commit/ae0e81a5bfa217855a17c9b09a502aa91f39c7fe ae0e81a5bfa217855a17c9b09a502aa91f39c7fe 2009-06-05T21:56:03-07:00 2009-06-05T21:56:03-07:00 moved the static 'with' methods to Input/Output class and made the internal open method on ResourceManager non-public. In this way, only the right methods will show up in the right context b53f515c5d71f905888a23b116ca0e59edac1985 wolfdancer wolfdancer@gmail.com