svn commit: r1552747 - /commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveEntry.java

[gg...@apache.org]

Author: ggregory
Date: Fri Dec 20 17:22:11 2013
New Revision: 1552747

URL: http://svn.apache.org/r1552747
Log:
Javadoc.

Modified:
    commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveEntry.java

Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveEntry.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveEntry.java?rev=1552747&r1=1552746&r2=1552747&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveEntry.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveEntry.java Fri Dec 20 17:22:11 2013
@@ -25,21 +25,34 @@ import java.util.Date;
  */
 public interface ArchiveEntry {
 
-    /** The name of the entry in the archive. May refer to a file or directory or other item */
+    /**
+     * Gets the name of the entry in this archive. May refer to a file or directory or other item.
+     * 
+     * @return The name of this entry in the archive.
+     */
     public String getName();
 
-    /** The (uncompressed) size of the entry. May be -1 (SIZE_UNKNOWN) if the size is unknown */
+    /**
+     * Gets the uncompressed size of this entry. May be -1 (SIZE_UNKNOWN) if the size is unknown
+     * 
+     * @return the uncompressed size of this entry.
+     */
     public long getSize();
 
     /** Special value indicating that the size is unknown */
     public static final long SIZE_UNKNOWN = -1;
 
-    /** True if the entry refers to a directory */
+    /**
+     * Returns true if this entry refers to a directory.
+     * 
+     * @return true if this entry refers to a directory.
+     */
     public boolean isDirectory();
 
     /**
-     * The last modified date of the entry.
+     * Gets the last modified date of this entry.
      * 
+     * @return the last modified date of this entry.
      * @since 1.1
      */
     public Date getLastModifiedDate();