Top Description Fields
org.apache.commons.compress.archivers.tar

public Interface TarConstants

Known Direct Implementers
org.apache.commons.compress.archivers.tar.TarArchiveEntry, org.apache.commons.compress.archivers.tar.TarArchiveSparseEntry

This interface contains all the definitions used in the package. For tar formats (FORMAT_OLDGNU, FORMAT_POSIX, etc.) see GNU tar tar.h type enum archive_format

Field Summary

Modifier and TypeField and Description
public static final int
ATIMELEN_GNU

The length of the access time field in an old GNU header buffer.

public static final int
ATIMELEN_XSTAR

The length of the access time field in a xstar header buffer.

public static final int
CHKSUM_OFFSET

Offset of the checksum field within header record.

public static final int
CHKSUMLEN

The length of the checksum field in a header buffer.

public static final int
CTIMELEN_GNU

The length of the created time field in an old GNU header buffer.

public static final int
CTIMELEN_XSTAR

The length of the created time field in a xstar header buffer.

public static final int
DEFAULT_BLKSIZE

Default block size

public static final int
DEFAULT_RCDSIZE

Default record size

public static final int
DEVLEN

The length of each of the device fields (major and minor) in a header buffer.

public static final int
FORMAT_OLDGNU

GNU format as per before tar 1.12.

public static final int
FORMAT_POSIX

Pure Posix format.

public static final int
FORMAT_XSTAR

xstar format used by Jörg Schilling's star.

public static final int
GIDLEN

The length of the group id field in a header buffer.

public static final int
GNAMELEN

The length of the group name field in a header buffer.

public static final String
GNU_LONGLINK

The name of the GNU tar entry which contains a long name.

public static final int
ISEXTENDEDLEN_GNU

The length of the is extension field in an old GNU header buffer.

public static final int
ISEXTENDEDLEN_GNU_SPARSE

The length of the is extension field in a sparse header buffer.

public static final byte
LF_BLK

Block device file type.

public static final byte
LF_CHR

Character device file type.

public static final byte
LF_CONTIG

Contiguous file type.

public static final byte
LF_DIR

Directory file type.

public static final byte
LF_FIFO

FIFO (pipe) file type.

public static final byte
LF_GNUTYPE_LONGLINK

Identifies the *next* file on the tape as having a long link name.

public static final byte
LF_GNUTYPE_LONGNAME

Identifies the *next* file on the tape as having a long name.

public static final byte
LF_GNUTYPE_SPARSE

Sparse file type.

public static final byte
LF_LINK

Link file type.

public static final byte
LF_MULTIVOLUME

Identifies the entry as a multi-volume past volume #0

public static final byte
LF_NORMAL

Normal file type.

public static final int
LF_OFFSET

Offset inside the header for the "link flag" field.

public static final byte
LF_OLDNORM

LF_ constants represent the "link flag" of an entry, or more commonly, the "entry type".

public static final byte
LF_PAX_EXTENDED_HEADER_LC

Identifies the entry as a Pax extended header.

public static final byte
LF_PAX_EXTENDED_HEADER_UC

Identifies the entry as a Pax extended header (SunOS tar -E).

public static final byte
LF_PAX_GLOBAL_EXTENDED_HEADER

Identifies the entry as a Pax global extended header.

public static final byte
LF_SYMLINK

Symbolic link file type.

public static final int
LONGNAMESLEN_GNU

The length of the long names field in an old GNU header buffer.

public static final String
MAGIC_ANT

The magic tag representing an Ant tar archive.

public static final String
MAGIC_GNU

The magic tag representing a GNU tar archive.

public static final int
MAGIC_OFFSET

Offset of start of magic field within header record

public static final String
MAGIC_POSIX

The magic tag representing a POSIX tar archive.

public static final String
MAGIC_XSTAR

The magix string used in the last four bytes of the header to identify the xstar format.

public static final int
MAGICLEN

The length of the magic field in a header buffer.

public static final long
MAXID

The maximum value of gid/uid in a tar archive which can be expressed in octal char notation (that's 7 sevens, octal).

public static final long
MAXSIZE

The maximum size of a file in a tar archive which can be expressed in octal char notation (that's 11 sevens, octal).

public static final int
MODELEN

The length of the mode field in a header buffer.

public static final int
MODTIMELEN

The length of the modification time field in a header buffer.

public static final int
NAMELEN

The length of the name field in a header buffer.

public static final int
OFFSETLEN_GNU

The length of the multivolume start offset field in an old GNU header buffer.

public static final int
PAD2LEN_GNU

The length of the padding field in an old GNU header buffer.

public static final int
PREFIXLEN

Length of the prefix field.

public static final int
PREFIXLEN_XSTAR

Length of the prefix field in xstar archives.

public static final int
REALSIZELEN_GNU

The length of the real size field in an old GNU header buffer.

public static final int
SIZELEN

The length of the size field in a header buffer.

public static final int
SPARSE_HEADERS_IN_EXTENSION_HEADER

The number of sparse headers in an extension header

public static final int
SPARSE_HEADERS_IN_OLDGNU_HEADER

The number of sparse headers in an old GNU header

public static final int
SPARSE_NUMBYTES_LEN

The length of numbytes in struct sparse

public static final int
SPARSE_OFFSET_LEN

The length of offset in struct sparse

public static final int
SPARSELEN_GNU

The sum of the length of all sparse headers in an old GNU header buffer.

public static final int
SPARSELEN_GNU_SPARSE

The sum of the length of all sparse headers in a sparse header buffer.

public static final int
UIDLEN

The length of the user id field in a header buffer.

public static final int
UNAMELEN

The length of the user name field in a header buffer.

public static final String
VERSION_ANT

The "version" representing an Ant tar archive.

public static final String
VERSION_GNU_SPACE

One of two possible GNU versions

public static final String
VERSION_GNU_ZERO

One of two possible GNU versions

public static final int
VERSION_OFFSET

Offset of start of magic field within header record

public static final String
public static final int
VERSIONLEN

Previously this was regarded as part of "magic" field, but it is separate.

public static final int
XSTAR_ATIME_OFFSET

Offset inside the header for the atime field in xstar archives.

public static final int
XSTAR_CTIME_OFFSET

Offset inside the header for the ctime field in xstar archives.

public static final int
XSTAR_MAGIC_LEN

Length of the XSTAR magic.

public static final int
XSTAR_MAGIC_OFFSET

Offset inside the header for the xstar magic bytes.

public static final int
XSTAR_MULTIVOLUME_OFFSET

Offset inside the header for the xtar multivolume data

public static final int
XSTAR_PREFIX_OFFSET

Offset inside the header for the prefix field in xstar archives.

Field Detail

ATIMELEN_GNUback to summary
public static final int ATIMELEN_GNU

The length of the access time field in an old GNU header buffer.

ATIMELEN_XSTARback to summary
public static final int ATIMELEN_XSTAR

The length of the access time field in a xstar header buffer.

Since
1.11
CHKSUM_OFFSETback to summary
public static final int CHKSUM_OFFSET

Offset of the checksum field within header record.

Since
1.5
CHKSUMLENback to summary
public static final int CHKSUMLEN

The length of the checksum field in a header buffer.

CTIMELEN_GNUback to summary
public static final int CTIMELEN_GNU

The length of the created time field in an old GNU header buffer.

CTIMELEN_XSTARback to summary
public static final int CTIMELEN_XSTAR

The length of the created time field in a xstar header buffer.

Since
1.11
DEFAULT_BLKSIZEback to summary
public static final int DEFAULT_BLKSIZE

Default block size

DEFAULT_RCDSIZEback to summary
public static final int DEFAULT_RCDSIZE

Default record size

DEVLENback to summary
public static final int DEVLEN

The length of each of the device fields (major and minor) in a header buffer.

FORMAT_OLDGNUback to summary
public static final int FORMAT_OLDGNU

GNU format as per before tar 1.12.

FORMAT_POSIXback to summary
public static final int FORMAT_POSIX

Pure Posix format.

FORMAT_XSTARback to summary
public static final int FORMAT_XSTAR

xstar format used by Jörg Schilling's star.

GIDLENback to summary
public static final int GIDLEN

The length of the group id field in a header buffer.

GNAMELENback to summary
public static final int GNAMELEN

The length of the group name field in a header buffer.

ISEXTENDEDLEN_GNUback to summary
public static final int ISEXTENDEDLEN_GNU

The length of the is extension field in an old GNU header buffer.

ISEXTENDEDLEN_GNU_SPARSEback to summary
public static final int ISEXTENDEDLEN_GNU_SPARSE

The length of the is extension field in a sparse header buffer.

LF_BLKback to summary
public static final byte LF_BLK

Block device file type.

LF_CHRback to summary
public static final byte LF_CHR

Character device file type.

LF_CONTIGback to summary
public static final byte LF_CONTIG

Contiguous file type.

LF_DIRback to summary
public static final byte LF_DIR

Directory file type.

LF_FIFOback to summary
public static final byte LF_FIFO

FIFO (pipe) file type.

LF_GNUTYPE_LONGNAMEback to summary
public static final byte LF_GNUTYPE_LONGNAME

Identifies the *next* file on the tape as having a long name.

LF_GNUTYPE_SPARSEback to summary
public static final byte LF_GNUTYPE_SPARSE

Sparse file type.

Since
1.1.1
LF_MULTIVOLUMEback to summary
public static final byte LF_MULTIVOLUME

Identifies the entry as a multi-volume past volume #0

Since
1.22
LF_NORMALback to summary
public static final byte LF_NORMAL

Normal file type.

LF_OFFSETback to summary
public static final int LF_OFFSET

Offset inside the header for the "link flag" field.

Since
1.22
See Also
TarArchiveEntry
LF_OLDNORMback to summary
public static final byte LF_OLDNORM

LF_ constants represent the "link flag" of an entry, or more commonly, the "entry type". This is the "old way" of indicating a normal file.

LF_PAX_EXTENDED_HEADER_LCback to summary
public static final byte LF_PAX_EXTENDED_HEADER_LC

Identifies the entry as a Pax extended header.

Since
1.1
LF_PAX_EXTENDED_HEADER_UCback to summary
public static final byte LF_PAX_EXTENDED_HEADER_UC

Identifies the entry as a Pax extended header (SunOS tar -E).

Since
1.1
LF_PAX_GLOBAL_EXTENDED_HEADERback to summary
public static final byte LF_PAX_GLOBAL_EXTENDED_HEADER

Identifies the entry as a Pax global extended header.

Since
1.1
LONGNAMESLEN_GNUback to summary
public static final int LONGNAMESLEN_GNU

The length of the long names field in an old GNU header buffer.

MAGIC_ANTback to summary
public static final String MAGIC_ANT

The magic tag representing an Ant tar archive.

Since
1.1
MAGIC_GNUback to summary
public static final String MAGIC_GNU

The magic tag representing a GNU tar archive.

MAGIC_OFFSETback to summary
public static final int MAGIC_OFFSET

Offset of start of magic field within header record

MAGIC_POSIXback to summary
public static final String MAGIC_POSIX

The magic tag representing a POSIX tar archive.

MAGIC_XSTARback to summary
public static final String MAGIC_XSTAR

The magix string used in the last four bytes of the header to identify the xstar format.

Since
1.11
MAGICLENback to summary
public static final int MAGICLEN

The length of the magic field in a header buffer.

MAXIDback to summary
public static final long MAXID

The maximum value of gid/uid in a tar archive which can be expressed in octal char notation (that's 7 sevens, octal).

MAXSIZEback to summary
public static final long MAXSIZE

The maximum size of a file in a tar archive which can be expressed in octal char notation (that's 11 sevens, octal).

MODELENback to summary
public static final int MODELEN

The length of the mode field in a header buffer.

MODTIMELENback to summary
public static final int MODTIMELEN

The length of the modification time field in a header buffer.

NAMELENback to summary
public static final int NAMELEN

The length of the name field in a header buffer.

OFFSETLEN_GNUback to summary
public static final int OFFSETLEN_GNU

The length of the multivolume start offset field in an old GNU header buffer.

PAD2LEN_GNUback to summary
public static final int PAD2LEN_GNU

The length of the padding field in an old GNU header buffer.

PREFIXLENback to summary
public static final int PREFIXLEN

Length of the prefix field.

PREFIXLEN_XSTARback to summary
public static final int PREFIXLEN_XSTAR

Length of the prefix field in xstar archives.

Since
1.11
REALSIZELEN_GNUback to summary
public static final int REALSIZELEN_GNU

The length of the real size field in an old GNU header buffer.

SIZELENback to summary
public static final int SIZELEN

The length of the size field in a header buffer. Includes the trailing space or NUL.

SPARSE_HEADERS_IN_EXTENSION_HEADERback to summary
public static final int SPARSE_HEADERS_IN_EXTENSION_HEADER

The number of sparse headers in an extension header

Since
1.20
SPARSE_HEADERS_IN_OLDGNU_HEADERback to summary
public static final int SPARSE_HEADERS_IN_OLDGNU_HEADER

The number of sparse headers in an old GNU header

Since
1.20
SPARSE_NUMBYTES_LENback to summary
public static final int SPARSE_NUMBYTES_LEN

The length of numbytes in struct sparse

Since
1.20
SPARSE_OFFSET_LENback to summary
public static final int SPARSE_OFFSET_LEN

The length of offset in struct sparse

Since
1.20
SPARSELEN_GNUback to summary
public static final int SPARSELEN_GNU

The sum of the length of all sparse headers in an old GNU header buffer.

SPARSELEN_GNU_SPARSEback to summary
public static final int SPARSELEN_GNU_SPARSE

The sum of the length of all sparse headers in a sparse header buffer.

UIDLENback to summary
public static final int UIDLEN

The length of the user id field in a header buffer.

UNAMELENback to summary
public static final int UNAMELEN

The length of the user name field in a header buffer.

VERSION_ANTback to summary
public static final String VERSION_ANT

The "version" representing an Ant tar archive.

Since
1.1
VERSION_GNU_SPACEback to summary
public static final String VERSION_GNU_SPACE

One of two possible GNU versions

VERSION_GNU_ZEROback to summary
public static final String VERSION_GNU_ZERO

One of two possible GNU versions

VERSION_OFFSETback to summary
public static final int VERSION_OFFSET

Offset of start of magic field within header record

VERSION_POSIXback to summary
public static final String VERSION_POSIX
VERSIONLENback to summary
public static final int VERSIONLEN

Previously this was regarded as part of "magic" field, but it is separate.

XSTAR_ATIME_OFFSETback to summary
public static final int XSTAR_ATIME_OFFSET

Offset inside the header for the atime field in xstar archives.

Since
1.22
See Also
TarArchiveEntry
XSTAR_CTIME_OFFSETback to summary
public static final int XSTAR_CTIME_OFFSET

Offset inside the header for the ctime field in xstar archives.

Since
1.22
See Also
TarArchiveEntry
XSTAR_MAGIC_LENback to summary
public static final int XSTAR_MAGIC_LEN

Length of the XSTAR magic.

Since
1.11
XSTAR_MAGIC_OFFSETback to summary
public static final int XSTAR_MAGIC_OFFSET

Offset inside the header for the xstar magic bytes.

Since
1.11
XSTAR_MULTIVOLUME_OFFSETback to summary
public static final int XSTAR_MULTIVOLUME_OFFSET

Offset inside the header for the xtar multivolume data

Since
1.22
See Also
TarArchiveEntry
XSTAR_PREFIX_OFFSETback to summary
public static final int XSTAR_PREFIX_OFFSET

Offset inside the header for the prefix field in xstar archives.

Since
1.22
See Also
TarArchiveEntry