You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by se...@apache.org on 2009/03/31 12:34:54 UTC

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

Author: sebb
Date: Tue Mar 31 10:34:52 2009
New Revision: 760389

URL: http://svn.apache.org/viewvc?rev=760389&view=rev
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=760389&r1=760388&r2=760389&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 Tue Mar 31 10:34:52 2009
@@ -23,9 +23,15 @@
  */
 public interface ArchiveEntry {
 
+    /** The name of the entry in the archive. May refer to a file or directory or other item */
 	public String getName();
 	
+	/** The (uncompressed) size of the entry. May be -1 (SIZE_UNKNOWN) if the size is unknown */
 	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 */
 	public boolean isDirectory();
 }