Document null return value of ArchiveInputStream.getNextEntry
-------------------------------------------------------------
Key: COMPRESS-66
URL: https://issues.apache.org/jira/browse/COMPRESS-66
Project: Commons Compress
Issue Type: Improvement
Reporter: Jukka Zitting
Priority: Trivial
The ArchiveInputStream.getNextEntry method should mention that the return value
will be null when there are no more entries in the archive stream.
{noformat}
Index:
src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java
===================================================================
--- src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java
(revision 760154)
+++ src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java
(working copy)
@@ -43,8 +43,10 @@
private static final int BYTE_MASK = 0xFF;
/**
- * Returns the next Archive Entry in this Stream.
- * @return the next entry
+ * Returns the next Archive Entry in this Stream.
+ *
+ * @return the next entry,
+ * or <code>null</code> if there are no more entries
* @throws IOException if the next entry could not be read
*/
public abstract ArchiveEntry getNextEntry() throws IOException;
{noformat}
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
