Author: bodewig
Date: Fri Nov 14 05:18:43 2014
New Revision: 1639571
URL: http://svn.apache.org/r1639571
Log:
document readBits EOF behavior explicitly
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/BitInputStream.java
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/BitInputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/BitInputStream.java?rev=1639571&r1=1639570&r2=1639571&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/BitInputStream.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/BitInputStream.java
Fri Nov 14 05:18:43 2014
@@ -73,7 +73,8 @@ public class BitInputStream implements C
* @param count the number of bits to read, must be a positive
* number not bigger than 31.
* @return the bits concatenated as an integer using the stream's byte
order.
- * -1 if the end of the underlying stream has been reached
+ * -1 if the end of the underlying stream has been reached before
reading
+ * the requested number of bits
*/
public int readBits(final int count) throws IOException {
if (count < 0 || count > MAXIMUM_CACHE_SIZE) {
