View Javadoc
1   /*
2    * Copyright (C) 2005-2015 Schlichtherle IT Services.
3    * All rights reserved. Use is subject to license terms.
4    */
5   package net.java.truevfs.comp.zip;
6   
7   import java.nio.charset.Charset;
8   
9   /**
10   * Defines the default character set for accessing ZIP files.
11   * 
12   * @author Christian Schlichtherle
13   */
14  public interface ZipCharsetParameters extends ZipParameters {
15  
16      /**
17       * Returns the default character set for comments and entry names in a ZIP
18       * file.
19       * When reading a ZIP file, this is used to decode comments and entry names
20       * in a ZIP file unless an entry has bit 11 set in its General Purpose Bit
21       * Flags.
22       * In this case, the character set is ignored and "UTF-8" is used for
23       * decoding the entry.
24       * This is in accordance to Appendix D of PKWARE's
25       * <a href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">ZIP File Format Specification</a>,
26       * version 6.3.0 and later.
27       * <p>
28       * This is an immutable property - multiple calls must return the same
29       * object.
30       * 
31       * @return The default character set for comments and entry names in a ZIP
32       *         file.
33       */
34      Charset getCharset();
35  }