public class TarEntry extends java.lang.Object implements TarConstants
TarEntries that are created from the header bytes read from an archive are instantiated with the TarEntry( 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 TarEntry( File ) 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[NAMSIZ]; char mode[8]; char uid[8]; char gid[8]; char size[12]; char mtime[12]; char chksum[8]; char linkflag; char linkname[NAMSIZ]; char magic[8]; char uname[TUNMLEN]; char gname[TGNMLEN]; char devmajor[8]; char devminor[8]; } header;
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_DIR_MODE
Default permissions bits for directories
|
static int |
DEFAULT_FILE_MODE
Default permissions bits for files
|
static int |
MAX_NAMELEN
Maximum length of a user's name in the tar file
|
static int |
MILLIS_PER_SECOND
Convert millis to seconds
|
CHKSUMLEN, DEVLEN, GIDLEN, GNAMELEN, GNU_LONGLINK, GNU_TMAGIC, LF_BLK, LF_CHR, LF_CONTIG, LF_DIR, LF_FIFO, LF_GNUTYPE_LONGNAME, LF_LINK, LF_NORMAL, LF_OLDNORM, LF_SYMLINK, MAGICLEN, MAXSIZE, MODELEN, MODTIMELEN, NAMELEN, SIZELEN, TMAGIC, UIDLEN, UNAMELEN
Constructor and Description |
---|
TarEntry(byte[] headerBuf)
Construct an entry from an archive's header bytes.
|
TarEntry(java.io.File file)
Construct an entry for a file.
|
TarEntry(java.lang.String name)
Construct an entry with only a name.
|
TarEntry(java.lang.String name,
boolean preserveLeadingSlashes)
Construct an entry with only a name.
|
TarEntry(java.lang.String name,
byte linkFlag)
Construct an entry with a name and a link flag.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object it)
Determine if the two entries are equal.
|
boolean |
equals(TarEntry it)
Determine if the two entries are equal.
|
TarEntry[] |
getDirectoryEntries()
If this entry represents a file, and the file is a directory, return
an array of TarEntries for this entry's children.
|
java.io.File |
getFile()
Get this entry's file.
|
int |
getGroupId()
Get this entry's group id.
|
java.lang.String |
getGroupName()
Get this entry's group name.
|
java.lang.String |
getLinkName()
Get this entry's link name.
|
int |
getMode()
Get this entry's mode.
|
java.util.Date |
getModTime()
Set this entry's modification time.
|
java.lang.String |
getName()
Get this entry's name.
|
long |
getSize()
Get this entry's file size.
|
int |
getUserId()
Get this entry's user id.
|
java.lang.String |
getUserName()
Get this entry's user name.
|
int |
hashCode()
Hashcodes are based on entry names.
|
boolean |
isDescendent(TarEntry desc)
Determine if the given entry is a descendant of this entry.
|
boolean |
isDirectory()
Return whether or not this entry represents a directory.
|
boolean |
isGNULongNameEntry()
Indicate if this entry is a GNU long name block
|
void |
parseTarHeader(byte[] header)
Parse an entry's header information from a header buffer.
|
void |
setGroupId(int groupId)
Set this entry's group id.
|
void |
setGroupName(java.lang.String groupName)
Set this entry's group name.
|
void |
setIds(int userId,
int groupId)
Convenience method to set this entry's group and user ids.
|
void |
setMode(int mode)
Set the mode for this entry
|
void |
setModTime(java.util.Date time)
Set this entry's modification time.
|
void |
setModTime(long time)
Set this entry's modification time.
|
void |
setName(java.lang.String name)
Set this entry's name.
|
void |
setNames(java.lang.String userName,
java.lang.String groupName)
Convenience method to set this entry's group and user names.
|
void |
setSize(long size)
Set this entry's file size.
|
void |
setUserId(int userId)
Set this entry's user id.
|
void |
setUserName(java.lang.String userName)
Set this entry's user name.
|
void |
writeEntryHeader(byte[] outbuf)
Write an entry's header information to a header buffer.
|
public static final int MAX_NAMELEN
public static final int DEFAULT_DIR_MODE
public static final int DEFAULT_FILE_MODE
public static final int MILLIS_PER_SECOND
public TarEntry(java.lang.String name)
name
- the entry namepublic TarEntry(java.lang.String name, boolean preserveLeadingSlashes)
name
- the entry namepreserveLeadingSlashes
- whether to allow leading slashes
in the name.public TarEntry(java.lang.String name, byte linkFlag)
name
- the entry namelinkFlag
- the entry link flag.public TarEntry(java.io.File file)
file
- The file that the entry represents.public TarEntry(byte[] headerBuf)
headerBuf
- The header bytes from a tar archive entry.public boolean equals(TarEntry it)
it
- Entry to be checked for equality.public boolean equals(java.lang.Object it)
equals
in class java.lang.Object
it
- Entry to be checked for equality.public int hashCode()
hashCode
in class java.lang.Object
public boolean isDescendent(TarEntry desc)
desc
- Entry to be checked as a descendent of this.public java.lang.String getName()
public void setName(java.lang.String name)
name
- This entry's new name.public void setMode(int mode)
mode
- the mode for this entrypublic java.lang.String getLinkName()
public int getUserId()
public void setUserId(int userId)
userId
- This entry's new user id.public int getGroupId()
public void setGroupId(int groupId)
groupId
- This entry's new group id.public java.lang.String getUserName()
public void setUserName(java.lang.String userName)
userName
- This entry's new user name.public java.lang.String getGroupName()
public void setGroupName(java.lang.String groupName)
groupName
- This entry's new group name.public void setIds(int userId, int groupId)
userId
- This entry's new user id.groupId
- This entry's new group id.public void setNames(java.lang.String userName, java.lang.String groupName)
userName
- This entry's new user name.groupName
- This entry's new group name.public void setModTime(long time)
time
- This entry's new modification time.public void setModTime(java.util.Date time)
time
- This entry's new modification time.public java.util.Date getModTime()
public java.io.File getFile()
public int getMode()
public long getSize()
public void setSize(long size)
size
- This entry's new file size.public boolean isGNULongNameEntry()
public boolean isDirectory()
public TarEntry[] getDirectoryEntries()
public void writeEntryHeader(byte[] outbuf)
outbuf
- The tar entry header buffer to fill in.public void parseTarHeader(byte[] header)
header
- The tar entry header buffer to get information from.