javadoc for HasCharset Signed-off-by: Simon Spero <sesunc...@gmail.com>
(cherry picked from commit b70c7c2) Signed-off-by: Simon Spero <sesunc...@gmail.com> Project: http://git-wip-us.apache.org/repos/asf/commons-compress/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-compress/commit/cb590b38 Tree: http://git-wip-us.apache.org/repos/asf/commons-compress/tree/cb590b38 Diff: http://git-wip-us.apache.org/repos/asf/commons-compress/diff/cb590b38 Branch: refs/heads/master Commit: cb590b38af2827acb4dc5ab3919415d3cc75d88c Parents: cec72ce Author: Simon Spero <sesunc...@gmail.com> Authored: Sat Jun 17 12:45:44 2017 -0400 Committer: Stefan Bodewig <bode...@apache.org> Committed: Wed Jul 5 16:30:00 2017 +0200 ---------------------------------------------------------------------- .../commons/compress/archivers/zip/HasCharset.java | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-compress/blob/cb590b38/src/main/java/org/apache/commons/compress/archivers/zip/HasCharset.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/HasCharset.java b/src/main/java/org/apache/commons/compress/archivers/zip/HasCharset.java index 09dfced..2e392a8 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/HasCharset.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/HasCharset.java @@ -2,10 +2,22 @@ package org.apache.commons.compress.archivers.zip; import java.nio.charset.Charset; +/** + * An interface added to allow access to the character set associated with an {@link NioZipEncoding}, + * without requiring a new method to be added to {@link ZipEncoding}. + * <p> + * This avoids introducing a + * potentially breaking change, or making {@link NioZipEncoding} a public class. + * </p> + */ public interface HasCharset { /** - * + * Provides access to the character set associated with an object. + * <p> + * This allows nio oriented code to use more natural character encoding/decoding methods, + * whilst allowing existing code to continue to rely on special-case error handling for UTF-8. + * </p> * @return the character set associated with this object */ Charset getCharset();
