[COMPRESS-66] Document null return value of ArchiveInputStream.getNextEntry

• Type: Improvement
• Status: Resolved
• Priority: Trivial
• Resolution: Fixed
• Fix Version/s: 1.0
• Assignee: Jukka Zitting
• Reporter: Jukka Zitting
• Created: 30/Mar/09 20:42
• Updated: 30/Mar/09 21:02
• Resolved: 30/Mar/09 21:02

Description

The ArchiveInputStream.getNextEntry method should mention that the return value will be null when there are no more entries in the archive stream.

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;