svn commit: r754906 - /commons/sandbox/compress/trunk/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java

[se...@apache.org]

Author: sebb
Date: Mon Mar 16 14:42:56 2009
New Revision: 754906

URL: http://svn.apache.org/viewvc?rev=754906&view=rev
Log:
Add Javadoc

Modified:
    commons/sandbox/compress/trunk/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java

Modified: commons/sandbox/compress/trunk/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java
URL: http://svn.apache.org/viewvc/commons/sandbox/compress/trunk/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java?rev=754906&r1=754905&r2=754906&view=diff
==============================================================================
--- commons/sandbox/compress/trunk/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java (original)
+++ commons/sandbox/compress/trunk/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java Mon Mar 16 14:42:56 2009
@@ -37,6 +37,15 @@
  */
 public class CompressorStreamFactory {
 
+    /**
+     * Create a compressor input stream from a compressor name and an input stream.
+     * 
+     * @param name of the compressor, i.e. "gz" or "bzip2"
+     * @param in the input stream
+     * @return compressor input stream
+     * @throws CompressorException if the compressor name is not known
+     * @throws IllegalArgumentException if the name or input stream is null
+     */
     public CompressorInputStream createCompressorInputStream(final String name,
             final InputStream in) throws CompressorException {
         if (name == null || in == null) {