UnicodeCommentExtraField (Apache Ant API)

java.lang.Object

org.apache.tools.zip.AbstractUnicodeExtraField

org.apache.tools.zip.UnicodeCommentExtraField

All Implemented Interfaces:: ZipExtraField

public class UnicodeCommentExtraField extends AbstractUnicodeExtraField

Info-ZIP Unicode Comment Extra Field (0x6375):

Stores the UTF-8 version of the file comment as stored in the central directory header.

See PKWARE's APPNOTE.TXT, section 4.6.8.

Field Summary

Fields

Modifier and Type

Field

Description

static final ZipShort

UCOM_ID
Constructor Summary

Constructors

Constructor

Description

UnicodeCommentExtraField()

UnicodeCommentExtraField(String comment, byte[] bytes)

Assemble as unicode comment extension from the comment given as text as well as the bytes actually written to the archive.

UnicodeCommentExtraField(String text, byte[] bytes, int off, int len)

Assemble as unicode comment extension from the name given as text as well as the encoded bytes actually written to the archive.
Method Summary

Modifier and Type

Method

Description

ZipShort

getHeaderId()

The Header-ID.

Methods inherited from class org.apache.tools.zip.AbstractUnicodeExtraField
getCentralDirectoryData, getCentralDirectoryLength, getLocalFileDataData, getLocalFileDataLength, getNameCRC32, getUnicodeName, parseFromLocalFileData, setNameCRC32, setUnicodeName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- UCOM_ID
  
  public static final ZipShort UCOM_ID
Constructor Details
- UnicodeCommentExtraField
  
  public UnicodeCommentExtraField()
- UnicodeCommentExtraField
  
  public UnicodeCommentExtraField(String text, byte[] bytes, int off, int len)
  
  Assemble as unicode comment extension from the name given as text as well as the encoded bytes actually written to the archive.
  
  Parameters:
  
  text - The file name
  
  bytes - the bytes actually written to the archive
  
  off - The offset of the encoded comment in bytes.
  
  len - The length of the encoded comment or comment in bytes.
- UnicodeCommentExtraField
  
  public UnicodeCommentExtraField(String comment, byte[] bytes)
  
  Assemble as unicode comment extension from the comment given as text as well as the bytes actually written to the archive.
  
  Parameters:
  
  comment - The file comment
  
  bytes - the bytes actually written to the archive
Method Details
- getHeaderId
  
  public ZipShort getHeaderId()
  
  The Header-ID.
  
  Returns:
  
  the header id