You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by bo...@apache.org on 2018/01/05 16:54:46 UTC

[5/6] commons-compress git commit: COMPRESS-429 javadocs

COMPRESS-429 javadocs


Project: http://git-wip-us.apache.org/repos/asf/commons-compress/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-compress/commit/83923434
Tree: http://git-wip-us.apache.org/repos/asf/commons-compress/tree/83923434
Diff: http://git-wip-us.apache.org/repos/asf/commons-compress/diff/83923434

Branch: refs/heads/COMPRESS-429
Commit: 8392343410d501f2fa772b4e6c1ab3d00ec167c6
Parents: d549178
Author: Stefan Bodewig <bo...@apache.org>
Authored: Fri Jan 5 17:54:05 2018 +0100
Committer: Stefan Bodewig <bo...@apache.org>
Committed: Fri Jan 5 17:54:05 2018 +0100

----------------------------------------------------------------------
 .../compress/archivers/zip/ZipArchiveEntry.java | 33 ++++++++++++++++++++
 1 file changed, 33 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-compress/blob/83923434/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
index 846b6f7..bbb451b 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
@@ -59,14 +59,47 @@ public class ZipArchiveEntry extends java.util.zip.ZipEntry
     private static final int SHORT_SHIFT = 16;
     private static final byte[] EMPTY = new byte[0];
 
+    /**
+     * Indicates how the name of this entry has been determined.
+     * @since 1.16
+     */
     public enum NameSource {
+        /**
+         * The name has been read from the archive using the encoding
+         * of the archive specified when creating the {@link
+         * ZipArchiveInputStream} or {@link ZipFile} (defaults to the
+         * platform's default encoding).
+         */
         NAME,
+        /**
+         * The name has been read from the archive and the archive
+         * specified the EFS flag which indicates the name has been
+         * encoded as UTF-8.
+         */
         NAME_WITH_EFS_FLAG,
+        /**
+         * The name has been read from an {@link UnicodePathExtraField
+         * Unicode Extra Field}.
+         */
         UNICODE_EXTRA_FIELD
     }
 
+    /**
+     * Indicates how the comment of this entry has been determined.
+     * @since 1.16
+     */
     public enum CommentSource {
+        /**
+         * The comment has been read from the archive using the encoding
+         * of the archive specified when creating the {@link
+         * ZipArchiveInputStream} or {@link ZipFile} (defaults to the
+         * platform's default encoding).
+         */
         COMMENT,
+        /**
+         * The comment has been read from an {@link UnicodeCommentExtraField
+         * Unicode Extra Field}.
+         */
         UNICODE_EXTRA_FIELD
     }