Author: bodewig
Date: Fri Dec 20 17:54:16 2013
New Revision: 1552766

URL: http://svn.apache.org/r1552766
Log:
make clear AbstractLZWInputStream is only public for technical reasons

Added:
    
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/z/_internal_/
    
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/z/_internal_/InternalLZWInputStream.java
      - copied, changed from r1552755, 
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/z/AbstractLZWInputStream.java
Removed:
    
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/z/AbstractLZWInputStream.java
Modified:
    
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnshrinkingInputStream.java
    
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/z/ZCompressorInputStream.java

Modified: 
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnshrinkingInputStream.java
URL: 
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnshrinkingInputStream.java?rev=1552766&r1=1552765&r2=1552766&view=diff
==============================================================================
--- 
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnshrinkingInputStream.java
 (original)
+++ 
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnshrinkingInputStream.java
 Fri Dec 20 17:54:16 2013
@@ -21,14 +21,14 @@ package org.apache.commons.compress.arch
 import java.io.IOException;
 import java.io.InputStream;
 
-import org.apache.commons.compress.compressors.z.AbstractLZWInputStream;
+import 
org.apache.commons.compress.compressors.z._internal_.InternalLZWInputStream;
 
 /**
  * Input stream that decompresses ZIP method 1 (unshrinking). A variation of 
the LZW algorithm, with some twists.
  * @NotThreadSafe
  * @since 1.7
  */
-class UnshrinkingInputStream extends AbstractLZWInputStream {
+class UnshrinkingInputStream extends InternalLZWInputStream {
     private static final int MAX_CODE_SIZE = 13;
     private static final int MAX_TABLE_SIZE = 1 << MAX_CODE_SIZE;
     private final boolean[] isUsed;

Modified: 
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/z/ZCompressorInputStream.java
URL: 
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/z/ZCompressorInputStream.java?rev=1552766&r1=1552765&r2=1552766&view=diff
==============================================================================
--- 
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/z/ZCompressorInputStream.java
 (original)
+++ 
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/z/ZCompressorInputStream.java
 Fri Dec 20 17:54:16 2013
@@ -20,13 +20,14 @@ package org.apache.commons.compress.comp
 
 import java.io.IOException;
 import java.io.InputStream;
+import 
org.apache.commons.compress.compressors.z._internal_.InternalLZWInputStream;
 
 /**
  * Input stream that decompresses .Z files.
  * @NotThreadSafe
  * @since 1.7
  */
-public class ZCompressorInputStream extends AbstractLZWInputStream {
+public class ZCompressorInputStream extends InternalLZWInputStream {
     private static final int MAGIC_1 = 0x1f;
     private static final int MAGIC_2 = 0x9d;
     private static final int BLOCK_MODE_MASK = 0x80;
@@ -59,6 +60,12 @@ public class ZCompressorInputStream exte
         }
     }
 
+    /**
+     * {@inheritDoc}
+     * <p><strong>This method is only protected for technical reasons
+     * and is not part of Commons Compress' published API.  It may
+     * change without warning.</strong></p>
+     */
     @Override
     protected int readNextCode() throws IOException {
         int code = super.readNextCode();
@@ -84,6 +91,12 @@ public class ZCompressorInputStream exte
         bitsCachedSize = 0;
     }
     
+    /**
+     * {@inheritDoc}
+     * <p><strong>This method is only protected for technical reasons
+     * and is not part of Commons Compress' published API.  It may
+     * change without warning.</strong></p>
+     */
     @Override
     protected int addEntry(int previousCode, byte character) throws 
IOException {
         final int maxTableSize = 1 << codeSize;
@@ -95,6 +108,12 @@ public class ZCompressorInputStream exte
         return r;
     }
 
+    /**
+     * {@inheritDoc}
+     * <p><strong>This method is only protected for technical reasons
+     * and is not part of Commons Compress' published API.  It may
+     * change without warning.</strong></p>
+     */
     @Override
     protected int decompressNextSymbol() throws IOException {
         //

Copied: 
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/z/_internal_/InternalLZWInputStream.java
 (from r1552755, 
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/z/AbstractLZWInputStream.java)
URL: 
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/z/_internal_/InternalLZWInputStream.java?p2=commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/z/_internal_/InternalLZWInputStream.java&p1=commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/z/AbstractLZWInputStream.java&r1=1552755&r2=1552766&rev=1552766&view=diff
==============================================================================
--- 
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/z/AbstractLZWInputStream.java
 (original)
+++ 
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/z/_internal_/InternalLZWInputStream.java
 Fri Dec 20 17:54:16 2013
@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-package org.apache.commons.compress.compressors.z;
+package org.apache.commons.compress.compressors.z._internal_;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -26,10 +26,14 @@ import org.apache.commons.compress.compr
 /**
  * Base-class for traditional Unix ".Z" compression and the
  * Unshrinking method of ZIP archive.
+ *
+ * <p><strong>This class is only public for technical reasons and is
+ * not part of Commons Compress' published API.  It may change without
+ * warning.</strong></p>
  * @NotThreadSafe
  * @since 1.7
  */
-public abstract class AbstractLZWInputStream extends CompressorInputStream {
+public abstract class InternalLZWInputStream extends CompressorInputStream {
     private final byte[] oneByte = new byte[1];
 
     protected final InputStream in;
@@ -44,7 +48,7 @@ public abstract class AbstractLZWInputSt
     private byte[] outputStack;
     private int outputStackLocation;
 
-    public AbstractLZWInputStream(InputStream inputStream) throws IOException {
+    protected InternalLZWInputStream(InputStream inputStream) throws 
IOException {
         this.in = inputStream;
     }
 


Reply via email to