Class TarArchiveEntry
- All Implemented Interfaces:
ArchiveEntry,EntryStreamOffsets,TarConstants
TarEntries that are created from the header bytes read from an archive are instantiated with the TarArchiveEntry(byte[]) constructor.
These entries will be used when extracting from or listing the contents of an archive. These entries have their header filled in using the header bytes. They
also set the File to null, since they reference an archive entry not a file.
TarEntries that are created from Files that are to be written into an archive are instantiated with the TarArchiveEntry(File) or
TarArchiveEntry(Path) constructor. These entries have their header filled in using the File's information. They also keep a reference
to the File for convenience when writing entries.
Finally, TarEntries can be constructed from nothing but a name. This allows the programmer to construct the entry by hand, for instance when only an InputStream is available for writing to the archive, and the header information is constructed from other information. In this case the header fields are set to defaults and the File is set to null.
The C structure for a Tar Entry's header is:
struct header {
char name[100]; // TarConstants.NAMELEN - offset 0
char mode[8]; // TarConstants.MODELEN - offset 100
char uid[8]; // TarConstants.UIDLEN - offset 108
char gid[8]; // TarConstants.GIDLEN - offset 116
char size[12]; // TarConstants.SIZELEN - offset 124
char mtime[12]; // TarConstants.MODTIMELEN - offset 136
char chksum[8]; // TarConstants.CHKSUMLEN - offset 148
char linkflag[1]; // - offset 156
char linkname[100]; // TarConstants.NAMELEN - offset 157
// The following fields are only present in new-style POSIX tar archives:
char magic[6]; // TarConstants.MAGICLEN - offset 257
char version[2]; // TarConstants.VERSIONLEN - offset 263
char uname[32]; // TarConstants.UNAMELEN - offset 265
char gname[32]; // TarConstants.GNAMELEN - offset 297
char devmajor[8]; // TarConstants.DEVLEN - offset 329
char devminor[8]; // TarConstants.DEVLEN - offset 337
char prefix[155]; // TarConstants.PREFIXLEN - offset 345
// Used if "name" field is not long enough to hold the path
char pad[12]; // NULs - offset 500
} header;
All unused bytes are set to null. New-style GNU tar files are slightly different from the above. For values of size larger than 077777777777L (11 7s) or uid
and gid larger than 07777777L (7 7s) the sign bit of the first byte is set, and the rest of the field is the binary representation of the number. See
TarUtils.parseOctalOrBinary(byte[], int, int).
The C structure for a old GNU Tar Entry's header is:
struct oldgnu_header {
char unused_pad1[345]; // TarConstants.PAD1LEN_GNU - offset 0
char atime[12]; // TarConstants.ATIMELEN_GNU - offset 345
char ctime[12]; // TarConstants.CTIMELEN_GNU - offset 357
char offset[12]; // TarConstants.OFFSETLEN_GNU - offset 369
char longnames[4]; // TarConstants.LONGNAMESLEN_GNU - offset 381
char unused_pad2; // TarConstants.PAD2LEN_GNU - offset 385
struct sparse sp[4]; // TarConstants.SPARSELEN_GNU - offset 386
char isextended; // TarConstants.ISEXTENDEDLEN_GNU - offset 482
char realsize[12]; // TarConstants.REALSIZELEN_GNU - offset 483
char unused_pad[17]; // TarConstants.PAD3LEN_GNU - offset 495
};
Whereas, "struct sparse" is:
struct sparse {
char offset[12]; // offset 0
char numbytes[12]; // offset 12
};
The C structure for a xstar (Jörg Schilling star) Tar Entry's header is:
struct star_header {
char name[100]; // offset 0
char mode[8]; // offset 100
char uid[8]; // offset 108
char gid[8]; // offset 116
char size[12]; // offset 124
char mtime[12]; // offset 136
char chksum[8]; // offset 148
char typeflag; // offset 156
char linkname[100]; // offset 157
char magic[6]; // offset 257
char version[2]; // offset 263
char uname[32]; // offset 265
char gname[32]; // offset 297
char devmajor[8]; // offset 329
char devminor[8]; // offset 337
char prefix[131]; // offset 345
char atime[12]; // offset 476
char ctime[12]; // offset 488
char mfill[8]; // offset 500
char xmagic[4]; // offset 508 "tar\0"
};
which is identical to new-style POSIX up to the first 130 bytes of the prefix.
The C structure for the xstar-specific parts of a xstar Tar Entry's header is:
struct xstar_in_header {
char fill[345]; // offset 0 Everything before t_prefix
char prefix[1]; // offset 345 Prefix for t_name
char fill2; // offset 346
char fill3[8]; // offset 347
char isextended; // offset 355
struct sparse sp[SIH]; // offset 356 8 x 12
char realsize[12]; // offset 452 Real size for sparse data
char offset[12]; // offset 464 Offset for multivolume data
char atime[12]; // offset 476
char ctime[12]; // offset 488
char mfill[8]; // offset 500
char xmagic[4]; // offset 508 "tar\0"
};
- This class is not thread-safe
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intDefault permissions bits for directoriesstatic final intDefault permissions bits for filesstatic final intMaximum length of a user's name in the tar filestatic final intDeprecated.Unused.static final longValue used to indicate unknown mode, user/groupids, device numbers and modTime when parsing a file in lenient mode and the archive contains illegal fields.Fields inherited from interface org.apache.commons.compress.archivers.ArchiveEntry
SIZE_UNKNOWNFields inherited from interface org.apache.commons.compress.archivers.EntryStreamOffsets
OFFSET_UNKNOWNFields inherited from interface org.apache.commons.compress.archivers.tar.TarConstants
ATIMELEN_GNU, ATIMELEN_XSTAR, CHKSUM_OFFSET, CHKSUMLEN, CTIMELEN_GNU, CTIMELEN_XSTAR, DEFAULT_BLKSIZE, DEFAULT_RCDSIZE, DEVLEN, FORMAT_OLDGNU, FORMAT_POSIX, FORMAT_XSTAR, GIDLEN, GNAMELEN, GNU_LONGLINK, ISEXTENDEDLEN_GNU, ISEXTENDEDLEN_GNU_SPARSE, LF_BLK, LF_CHR, LF_CONTIG, LF_DIR, LF_FIFO, LF_GNUTYPE_LONGLINK, LF_GNUTYPE_LONGNAME, LF_GNUTYPE_SPARSE, LF_LINK, LF_MULTIVOLUME, LF_NORMAL, LF_OFFSET, LF_OLDNORM, LF_PAX_EXTENDED_HEADER_LC, LF_PAX_EXTENDED_HEADER_UC, LF_PAX_GLOBAL_EXTENDED_HEADER, LF_SYMLINK, LONGNAMESLEN_GNU, MAGIC_ANT, MAGIC_GNU, MAGIC_OFFSET, MAGIC_POSIX, MAGIC_XSTAR, MAGICLEN, MAXID, MAXSIZE, MODELEN, MODTIMELEN, NAMELEN, OFFSETLEN_GNU, PAD2LEN_GNU, PREFIXLEN, PREFIXLEN_XSTAR, REALSIZELEN_GNU, SIZELEN, SPARSE_HEADERS_IN_EXTENSION_HEADER, SPARSE_HEADERS_IN_OLDGNU_HEADER, SPARSE_NUMBYTES_LEN, SPARSE_OFFSET_LEN, SPARSELEN_GNU, SPARSELEN_GNU_SPARSE, UIDLEN, UNAMELEN, VERSION_ANT, VERSION_GNU_SPACE, VERSION_GNU_ZERO, VERSION_OFFSET, VERSION_POSIX, VERSIONLEN, XSTAR_ATIME_OFFSET, XSTAR_CTIME_OFFSET, XSTAR_MAGIC_LEN, XSTAR_MAGIC_OFFSET, XSTAR_MULTIVOLUME_OFFSET, XSTAR_PREFIX_OFFSET -
Constructor Summary
ConstructorsConstructorDescriptionTarArchiveEntry(byte[] headerBuf) Constructs an entry from an archive's header bytes.TarArchiveEntry(byte[] headerBuf, ZipEncoding encoding) Constructs an entry from an archive's header bytes.TarArchiveEntry(byte[] headerBuf, ZipEncoding encoding, boolean lenient) Constructs an entry from an archive's header bytes.TarArchiveEntry(byte[] headerBuf, ZipEncoding encoding, boolean lenient, long dataOffset) Constructs an entry from an archive's header bytes for random access tar.TarArchiveEntry(File file) Constructs an entry for a file.TarArchiveEntry(File file, String fileName) Constructs an entry for a file.TarArchiveEntry(String name) Constructs an entry with only a name.TarArchiveEntry(String name, boolean preserveAbsolutePath) Constructs an entry with only a name.TarArchiveEntry(String name, byte linkFlag) Constructs an entry with a name and a link flag.TarArchiveEntry(String name, byte linkFlag, boolean preserveAbsolutePath) Constructs an entry with a name and a link flag.TarArchiveEntry(Path file) Constructs an entry for a file.TarArchiveEntry(Path file, String fileName, LinkOption... linkOptions) Constructs an entry for a file.TarArchiveEntry(Map<String, String> globalPaxHeaders, byte[] headerBuf, ZipEncoding encoding, boolean lenient) Constructs an entry from an archive's header bytes.TarArchiveEntry(Map<String, String> globalPaxHeaders, byte[] headerBuf, ZipEncoding encoding, boolean lenient, long dataOffset) Constructs an entry from an archive's header bytes for random access tar. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddPaxHeader(String name, String value) Adds a PAX header to this entry.voidClears all extra PAX headers.booleanDetermine if the two entries are equal.booleanDetermine if the two entries are equal.Gets this entry's creation time.longGets the offset of data stream within the archive file,intGets this entry's major device number.intGets this entry's minor device number.If this entry represents a file, and the file is a directory, return an array of TarEntries for this entry's children.getExtraPaxHeader(String name) Gets named extra PAX headerGets extra PAX HeadersgetFile()Gets this entry's file.intDeprecated.use #getLongGroupId instead as group ids can be bigger thanInteger.MAX_VALUEGets this entry's group name.Gets this entry's last access time.Gets this entry's modification time.Gets this entry's modification time.byteGets this entry's link flag.Gets this entry's link name.longGets this entry's group id.longGets this entry's user id.intgetMode()Gets this entry's mode.Gets this entry's modification time.getName()Gets this entry's name.Gets this entry's sparse headers ordered by offset with all empty sparse sections at the start filtered out.getPath()Gets this entry's file.longGets this entry's real file size in case of a sparse file.longgetSize()Gets this entry's file size.Gets this entry's sparse headersGets this entry's status change time.intDeprecated.use #getLongUserId instead as user ids can be bigger thanInteger.MAX_VALUEGets this entry's user name.inthashCode()Hash codes are based on entry names.booleanTests whether this is a block device entry.booleanTests whether this is a character device entry.booleanTests whether this entry's checksum status.booleanisDescendent(TarArchiveEntry desc) Tests whether the given entry is a descendant of this entry.booleanTests whether or not this entry represents a directory.booleanTests whether in case of an oldgnu sparse file if an extension sparse header follows.booleanisFIFO()Tests whether this is a FIFO (pipe) entry.booleanisFile()Tests whether this is a "normal file"booleanTests whether this is a Pax header.booleanTests whether this entry is a GNU long linkname blockbooleanTests whether this entry is a GNU long name blockbooleanTests whether this entry is a GNU sparse block.booleanisLink()Tests whether this is a link entry.booleanTests whether this entry is a GNU or star sparse block using the oldgnu format.booleanTests whether this entry is a sparse file with 1.X PAX Format or notbooleanTests whether this entry is a GNU sparse block using one of the PAX formats.booleanTests whether this is a Pax header.booleanisSparse()Tests whether this is a sparse entry.booleanTests whether this entry is a star sparse block using PAX headers.booleanTests whether the stream is contiguous, that is, not split among several archive parts, interspersed with control blocks, and so on.booleanTests whether this is a symbolic link entry.voidparseTarHeader(byte[] header) Parses an entry's header information from a header buffer.voidparseTarHeader(byte[] header, ZipEncoding encoding) Parse an entry's header information from a header buffer.voidsetCreationTime(FileTime time) Sets this entry's creation time.voidsetDataOffset(long dataOffset) Sets the offset of the data for the tar entry.voidsetDevMajor(int devNo) Sets this entry's major device number.voidsetDevMinor(int devNo) Sets this entry's minor device number.voidsetGroupId(int groupId) Sets this entry's group id.voidsetGroupId(long groupId) Sets this entry's group id.voidsetGroupName(String groupName) Sets this entry's group name.voidsetIds(int userId, int groupId) Convenience method to set this entry's group and user ids.voidsetLastAccessTime(FileTime time) Sets this entry's last access time.voidsetLastModifiedTime(FileTime time) Sets this entry's modification time.voidsetLinkName(String link) Sets this entry's link name.voidsetMode(int mode) Sets the mode for this entryvoidsetModTime(long time) Sets this entry's modification time.voidsetModTime(FileTime time) Sets this entry's modification time.voidsetModTime(Date time) Sets this entry's modification time.voidSets this entry's name.voidConvenience method to set this entry's group and user names.voidsetSize(long size) Sets this entry's file size.voidsetSparseHeaders(List<TarArchiveStructSparse> sparseHeaders) Sets this entry's sparse headersvoidsetStatusChangeTime(FileTime time) Sets this entry's status change time.voidsetUserId(int userId) Sets this entry's user id.voidsetUserId(long userId) Sets this entry's user id.voidsetUserName(String userName) Sets this entry's user name.voidwriteEntryHeader(byte[] outbuf) Writes an entry's header information to a header buffer.voidwriteEntryHeader(byte[] outbuf, ZipEncoding encoding, boolean starMode) Writes an entry's header information to a header buffer.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.commons.compress.archivers.ArchiveEntry
resolveIn
-
Field Details
-
UNKNOWN
Value used to indicate unknown mode, user/groupids, device numbers and modTime when parsing a file in lenient mode and the archive contains illegal fields.- Since:
- 1.19
- See Also:
-
MAX_NAMELEN
Maximum length of a user's name in the tar file- See Also:
-
DEFAULT_DIR_MODE
Default permissions bits for directories- See Also:
-
DEFAULT_FILE_MODE
Default permissions bits for files- See Also:
-
MILLIS_PER_SECOND
Deprecated.Unused.Convert millis to seconds- See Also:
-
-
Constructor Details
-
TarArchiveEntry
Constructs an entry from an archive's header bytes. File is set to null.- Parameters:
headerBuf- The header bytes from a tar archive entry.- Throws:
IllegalArgumentException- if any of the numeric fields have an invalid format
-
TarArchiveEntry
Constructs an entry from an archive's header bytes. File is set to null.- Parameters:
headerBuf- The header bytes from a tar archive entry.encoding- encoding to use for file names- Throws:
IllegalArgumentException- if any of the numeric fields have an invalid formatIOException- on error- Since:
- 1.4
-
TarArchiveEntry
Constructs an entry from an archive's header bytes. File is set to null.- Parameters:
headerBuf- The header bytes from a tar archive entry.encoding- encoding to use for file nameslenient- when set to true illegal values for group/userid, mode, device numbers and timestamp will be ignored and the fields set toUNKNOWN. When set to false such illegal fields cause an exception instead.- Throws:
IllegalArgumentException- if any of the numeric fields have an invalid formatIOException- on error- Since:
- 1.19
-
TarArchiveEntry
public TarArchiveEntry(byte[] headerBuf, ZipEncoding encoding, boolean lenient, long dataOffset) throws IOException Constructs an entry from an archive's header bytes for random access tar. File is set to null.- Parameters:
headerBuf- the header bytes from a tar archive entry.encoding- encoding to use for file names.lenient- when set to true illegal values for group/userid, mode, device numbers and timestamp will be ignored and the fields set toUNKNOWN. When set to false such illegal fields cause an exception instead.dataOffset- position of the entry data in the random access file.- Throws:
IllegalArgumentException- if any of the numeric fields have an invalid format.IOException- on error.- Since:
- 1.21
-
TarArchiveEntry
Constructs an entry for a file. File is set to file, and the header is constructed from information from the file. The name is set from the normalized file path.The entry's name will be the value of the
file's path with all file separators replaced by forward slashes and leading slashes as well as Windows drive letters stripped. The name will end in a slash if thefilerepresents a directory.Note: Since 1.21 this internally uses the same code as the TarArchiveEntry constructors with a
Pathas parameter. But all thrown exceptions are ignored. If handling those exceptions is needed consider switching to the path constructors.- Parameters:
file- The file that the entry represents.
-
TarArchiveEntry
Constructs an entry for a file. File is set to file, and the header is constructed from information from the file.The entry's name will be the value of the
fileNameargument with all file separators replaced by forward slashes and leading slashes as well as Windows drive letters stripped. The name will end in a slash if thefilerepresents a directory.Note: Since 1.21 this internally uses the same code as the TarArchiveEntry constructors with a
Pathas parameter. But all thrown exceptions are ignored. If handling those exceptions is needed consider switching to the path constructors.- Parameters:
file- The file that the entry represents.fileName- the name to be used for the entry.
-
TarArchiveEntry
public TarArchiveEntry(Map<String, String> globalPaxHeaders, byte[] headerBuf, ZipEncoding encoding, boolean lenient) throws IOExceptionConstructs an entry from an archive's header bytes. File is set to null.- Parameters:
globalPaxHeaders- the parsed global PAX headers, or null if this is the first one.headerBuf- The header bytes from a tar archive entry.encoding- encoding to use for file nameslenient- when set to true illegal values for group/userid, mode, device numbers and timestamp will be ignored and the fields set toUNKNOWN. When set to false such illegal fields cause an exception instead.- Throws:
IllegalArgumentException- if any of the numeric fields have an invalid formatIOException- on error- Since:
- 1.22
-
TarArchiveEntry
public TarArchiveEntry(Map<String, String> globalPaxHeaders, byte[] headerBuf, ZipEncoding encoding, boolean lenient, long dataOffset) throws IOExceptionConstructs an entry from an archive's header bytes for random access tar. File is set to null.- Parameters:
globalPaxHeaders- the parsed global PAX headers, or null if this is the first one.headerBuf- the header bytes from a tar archive entry.encoding- encoding to use for file names.lenient- when set to true illegal values for group/userid, mode, device numbers and timestamp will be ignored and the fields set toUNKNOWN. When set to false such illegal fields cause an exception instead.dataOffset- position of the entry data in the random access file.- Throws:
IllegalArgumentException- if any of the numeric fields have an invalid format.IOException- on error.- Since:
- 1.22
-
TarArchiveEntry
Constructs an entry for a file. File is set to file, and the header is constructed from information from the file. The name is set from the normalized file path.The entry's name will be the value of the
file's path with all file separators replaced by forward slashes and leading slashes as well as Windows drive letters stripped. The name will end in a slash if thefilerepresents a directory.- Parameters:
file- The file that the entry represents.- Throws:
IOException- if an I/O error occurs- Since:
- 1.21
-
TarArchiveEntry
Constructs an entry for a file. File is set to file, and the header is constructed from information from the file.The entry's name will be the value of the
fileNameargument with all file separators replaced by forward slashes and leading slashes as well as Windows drive letters stripped. The name will end in a slash if thefilerepresents a directory.- Parameters:
file- The file that the entry represents.fileName- the name to be used for the entry.linkOptions- options indicating how symbolic links are handled.- Throws:
IOException- if an I/O error occurs- Since:
- 1.21
-
TarArchiveEntry
Constructs an entry with only a name. This allows the programmer to construct the entry's header "by hand". File is set to null.The entry's name will be the value of the
nameargument with all file separators replaced by forward slashes and leading slashes as well as Windows drive letters stripped.- Parameters:
name- the entry name
-
TarArchiveEntry
Constructs an entry with only a name. This allows the programmer to construct the entry's header "by hand". File is set to null.The entry's name will be the value of the
nameargument with all file separators replaced by forward slashes. Leading slashes and Windows drive letters are stripped ifpreserveAbsolutePathisfalse.- Parameters:
name- the entry namepreserveAbsolutePath- whether to allow leading slashes or drive letters in the name.- Since:
- 1.1
-
TarArchiveEntry
Constructs an entry with a name and a link flag.The entry's name will be the value of the
nameargument with all file separators replaced by forward slashes and leading slashes as well as Windows drive letters stripped.- Parameters:
name- the entry namelinkFlag- the entry link flag.
-
TarArchiveEntry
Constructs an entry with a name and a link flag.The entry's name will be the value of the
nameargument with all file separators replaced by forward slashes. Leading slashes and Windows drive letters are stripped ifpreserveAbsolutePathisfalse.- Parameters:
name- the entry namelinkFlag- the entry link flag.preserveAbsolutePath- whether to allow leading slashes or drive letters in the name.- Since:
- 1.5
-
-
Method Details
-
addPaxHeader
Adds a PAX header to this entry. If the header corresponds to an existing field in the entry, that field will be set; otherwise the header will be added to the extraPaxHeaders Map- Parameters:
name- The full name of the header to set.value- value of header.- Since:
- 1.15
-
clearExtraPaxHeaders
Clears all extra PAX headers.- Since:
- 1.15
-
equals
Determine if the two entries are equal. Equality is determined by the header names being equal. -
equals
Determine if the two entries are equal. Equality is determined by the header names being equal.- Parameters:
it- Entry to be checked for equality.- Returns:
- True if the entries are equal.
-
getCreationTime
Gets this entry's creation time.- Returns:
- This entry's computed creation time.
- Since:
- 1.22
-
getDataOffset
Gets the offset of data stream within the archive file,- Specified by:
getDataOffsetin interfaceEntryStreamOffsets- Returns:
- the offset of entry data stream,
OFFSET_UNKNOWNif not known. - Since:
- 1.21
-
getDevMajor
Gets this entry's major device number.- Returns:
- This entry's major device number.
- Since:
- 1.4
-
getDevMinor
Gets this entry's minor device number.- Returns:
- This entry's minor device number.
- Since:
- 1.4
-
getDirectoryEntries
If this entry represents a file, and the file is a directory, return an array of TarEntries for this entry's children.This method is only useful for entries created from a
FileorPathbut not for entries read from an archive.- Returns:
- An array of TarEntry's for this entry's children.
-
getExtraPaxHeader
Gets named extra PAX header- Parameters:
name- The full name of an extended PAX header to retrieve- Returns:
- The value of the header, if any.
- Since:
- 1.15
-
getExtraPaxHeaders
Gets extra PAX Headers- Returns:
- read-only map containing any extra PAX Headers
- Since:
- 1.15
-
getFile
Gets this entry's file.This method is only useful for entries created from a
FileorPathbut not for entries read from an archive.- Returns:
- this entry's file or null if the entry was not created from a file.
-
getGroupId
Deprecated.use #getLongGroupId instead as group ids can be bigger thanInteger.MAX_VALUEGets this entry's group id.- Returns:
- This entry's group id.
-
getGroupName
Gets this entry's group name.- Returns:
- This entry's group name.
-
getLastAccessTime
Gets this entry's last access time.- Returns:
- This entry's last access time.
- Since:
- 1.22
-
getLastModifiedDate
Gets this entry's modification time. This is equivalent togetLastModifiedTime(), but precision is truncated to milliseconds.- Specified by:
getLastModifiedDatein interfaceArchiveEntry- Returns:
- This entry's modification time.
- See Also:
-
getLastModifiedTime
Gets this entry's modification time.- Returns:
- This entry's modification time.
- Since:
- 1.22
-
getLinkFlag
Gets this entry's link flag.- Returns:
- this entry's link flag.
- Since:
- 1.23
-
getLinkName
Gets this entry's link name.- Returns:
- This entry's link name.
-
getLongGroupId
Gets this entry's group id.- Returns:
- This entry's group id.
- Since:
- 1.10
-
getLongUserId
Gets this entry's user id.- Returns:
- This entry's user id.
- Since:
- 1.10
-
getMode
Gets this entry's mode.- Returns:
- This entry's mode.
-
getModTime
Gets this entry's modification time. This is equivalent togetLastModifiedTime(), but precision is truncated to milliseconds.- Returns:
- This entry's modification time.
- See Also:
-
getName
Gets this entry's name.This method returns the raw name as it is stored inside of the archive.
- Specified by:
getNamein interfaceArchiveEntry- Returns:
- This entry's name.
-
getOrderedSparseHeaders
Gets this entry's sparse headers ordered by offset with all empty sparse sections at the start filtered out.- Returns:
- immutable list of this entry's sparse headers, never null
- Throws:
IOException- if the list of sparse headers contains blocks that overlap- Since:
- 1.21
-
getPath
Gets this entry's file.This method is only useful for entries created from a
FileorPathbut not for entries read from an archive.- Returns:
- this entry's file or null if the entry was not created from a file.
- Since:
- 1.21
-
getRealSize
Gets this entry's real file size in case of a sparse file.This is the size a file would take on disk if the entry was expanded.
If the file is not a sparse file, return size instead of realSize.
- Returns:
- This entry's real file size, if the file is not a sparse file, return size instead of realSize.
-
getSize
Gets this entry's file size.This is the size the entry's data uses inside the archive. Usually this is the same as
getRealSize(), but it doesn't take the "holes" into account when the entry represents a sparse file.- Specified by:
getSizein interfaceArchiveEntry- Returns:
- This entry's file size.
-
getSparseHeaders
Gets this entry's sparse headers- Returns:
- This entry's sparse headers
- Since:
- 1.20
-
getStatusChangeTime
Gets this entry's status change time.- Returns:
- This entry's status change time.
- Since:
- 1.22
-
getUserId
Deprecated.use #getLongUserId instead as user ids can be bigger thanInteger.MAX_VALUEGets this entry's user id.- Returns:
- This entry's user id.
-
getUserName
Gets this entry's user name.- Returns:
- This entry's user name.
-
hashCode
Hash codes are based on entry names. -
isBlockDevice
Tests whether this is a block device entry.- Returns:
- whether this is a block device
- Since:
- 1.2
-
isCharacterDevice
Tests whether this is a character device entry.- Returns:
- whether this is a character device
- Since:
- 1.2
-
isCheckSumOK
Tests whether this entry's checksum status.- Returns:
- if the header checksum is reasonably correct
- Since:
- 1.5
- See Also:
-
isDescendent
Tests whether the given entry is a descendant of this entry. Descendancy is determined by the name of the descendant starting with this entry's name.- Parameters:
desc- Entry to be checked as a descendent of this.- Returns:
- True if entry is a descendant of this.
-
isDirectory
Tests whether or not this entry represents a directory.- Specified by:
isDirectoryin interfaceArchiveEntry- Returns:
- True if this entry is a directory.
-
isExtended
Tests whether in case of an oldgnu sparse file if an extension sparse header follows.- Returns:
- true if an extension oldgnu sparse header follows.
-
isFIFO
Tests whether this is a FIFO (pipe) entry.- Returns:
- whether this is a FIFO entry
- Since:
- 1.2
-
isFile
Tests whether this is a "normal file"- Returns:
- whether this is a "normal file"
- Since:
- 1.2
-
isGlobalPaxHeader
Tests whether this is a Pax header.- Returns:
trueif this is a Pax header.- Since:
- 1.1
-
isGNULongLinkEntry
Tests whether this entry is a GNU long linkname block- Returns:
- true if this is a long name extension provided by GNU tar
-
isGNULongNameEntry
Tests whether this entry is a GNU long name block- Returns:
- true if this is a long name extension provided by GNU tar
-
isGNUSparse
Tests whether this entry is a GNU sparse block.- Returns:
- true if this is a sparse extension provided by GNU tar
-
isLink
Tests whether this is a link entry.- Returns:
- whether this is a link entry
- Since:
- 1.2
-
isOldGNUSparse
Tests whether this entry is a GNU or star sparse block using the oldgnu format.- Returns:
- true if this is a sparse extension provided by GNU tar or star
- Since:
- 1.11
-
isPaxGNU1XSparse
Tests whether this entry is a sparse file with 1.X PAX Format or not- Returns:
- True if this entry is a sparse file with 1.X PAX Format
- Since:
- 1.20
-
isPaxGNUSparse
Tests whether this entry is a GNU sparse block using one of the PAX formats.- Returns:
- true if this is a sparse extension provided by GNU tar
- Since:
- 1.11
-
isPaxHeader
Tests whether this is a Pax header.- Returns:
trueif this is a Pax header.- Since:
- 1.1
-
isSparse
Tests whether this is a sparse entry.- Returns:
- whether this is a sparse entry
- Since:
- 1.11
-
isStarSparse
Tests whether this entry is a star sparse block using PAX headers.- Returns:
- true if this is a sparse extension provided by star
- Since:
- 1.11
-
isStreamContiguous
Tests whether the stream is contiguous, that is, not split among several archive parts, interspersed with control blocks, and so on.- Specified by:
isStreamContiguousin interfaceEntryStreamOffsets- Returns:
- true if stream is contiguous, false otherwise.
- Since:
- 1.21
-
isSymbolicLink
Tests whether this is a symbolic link entry.- Returns:
- whether this is a symbolic link
- Since:
- 1.2
-
parseTarHeader
Parses an entry's header information from a header buffer.- Parameters:
header- The tar entry header buffer to get information from.- Throws:
IllegalArgumentException- if any of the numeric fields have an invalid format
-
parseTarHeader
Parse an entry's header information from a header buffer.- Parameters:
header- The tar entry header buffer to get information from.encoding- encoding to use for file names- Throws:
IllegalArgumentException- if any of the numeric fields have an invalid formatIOException- on error- Since:
- 1.4
-
setCreationTime
Sets this entry's creation time.- Parameters:
time- This entry's new creation time.- Since:
- 1.22
-
setDataOffset
Sets the offset of the data for the tar entry.- Parameters:
dataOffset- the position of the data in the tar.- Since:
- 1.21
-
setDevMajor
Sets this entry's major device number.- Parameters:
devNo- This entry's major device number.- Throws:
IllegalArgumentException- if the devNo is < 0.- Since:
- 1.4
-
setDevMinor
Sets this entry's minor device number.- Parameters:
devNo- This entry's minor device number.- Throws:
IllegalArgumentException- if the devNo is < 0.- Since:
- 1.4
-
setGroupId
Sets this entry's group id.- Parameters:
groupId- This entry's new group id.
-
setGroupId
Sets this entry's group id.- Parameters:
groupId- This entry's new group id.- Since:
- 1.10
-
setGroupName
Sets this entry's group name.- Parameters:
groupName- This entry's new group name.
-
setIds
Convenience method to set this entry's group and user ids.- Parameters:
userId- This entry's new user id.groupId- This entry's new group id.
-
setLastAccessTime
Sets this entry's last access time.- Parameters:
time- This entry's new last access time.- Since:
- 1.22
-
setLastModifiedTime
Sets this entry's modification time.- Parameters:
time- This entry's new modification time.- Since:
- 1.22
-
setLinkName
Sets this entry's link name.- Parameters:
link- the link name to use.- Since:
- 1.1
-
setMode
Sets the mode for this entry- Parameters:
mode- the mode for this entry
-
setModTime
Sets this entry's modification time.- Parameters:
time- This entry's new modification time.- See Also:
-
setModTime
Sets this entry's modification time.- Parameters:
time- This entry's new modification time.- Since:
- 1.21
- See Also:
-
setModTime
Sets this entry's modification time. The parameter passed to this method is in "Java time".- Parameters:
time- This entry's new modification time.- See Also:
-
setName
Sets this entry's name.- Parameters:
name- This entry's new name.
-
setNames
Convenience method to set this entry's group and user names.- Parameters:
userName- This entry's new user name.groupName- This entry's new group name.
-
setSize
Sets this entry's file size.- Parameters:
size- This entry's new file size.- Throws:
IllegalArgumentException- if the size is < 0.
-
setSparseHeaders
Sets this entry's sparse headers- Parameters:
sparseHeaders- The new sparse headers- Since:
- 1.20
-
setStatusChangeTime
Sets this entry's status change time.- Parameters:
time- This entry's new status change time.- Since:
- 1.22
-
setUserId
Sets this entry's user id.- Parameters:
userId- This entry's new user id.
-
setUserId
Sets this entry's user id.- Parameters:
userId- This entry's new user id.- Since:
- 1.10
-
setUserName
Sets this entry's user name.- Parameters:
userName- This entry's new user name.
-
writeEntryHeader
Writes an entry's header information to a header buffer.This method does not use the star/GNU tar/BSD tar extensions.
- Parameters:
outbuf- The tar entry header buffer to fill in.
-
writeEntryHeader
public void writeEntryHeader(byte[] outbuf, ZipEncoding encoding, boolean starMode) throws IOException Writes an entry's header information to a header buffer.- Parameters:
outbuf- The tar entry header buffer to fill in.encoding- encoding to use when writing the file name.starMode- whether to use the star/GNU tar/BSD tar extension for numeric fields if their value doesn't fit in the maximum size of standard tar archives- Throws:
IOException- on error- Since:
- 1.4
-