org.apache.tools.tar
public class TarEntry extends 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;
Field Summary | |
---|---|
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 |
Constructor Summary | |
---|---|
TarEntry(String name)
Construct an entry with only a name. | |
TarEntry(String name, byte linkFlag)
Construct an entry with a name an a link flag.
| |
TarEntry(File file)
Construct an entry for a file. | |
TarEntry(byte[] headerBuf)
Construct an entry from an archive's header bytes. |
Method Summary | |
---|---|
boolean | equals(TarEntry it)
Determine if the two entries are equal. |
boolean | equals(Object 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.
|
File | getFile()
Get this entry's file.
|
int | getGroupId()
Get this entry's group id.
|
String | getGroupName()
Get this entry's group name.
|
String | getLinkName()
Get this entry's link name.
|
int | getMode()
Get this entry's mode.
|
Date | getModTime()
Set this entry's modification time.
|
String | getName()
Get this entry's name.
|
long | getSize()
Get this entry's file size.
|
int | getUserId()
Get this entry's user id.
|
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(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(long time)
Set this entry's modification time. |
void | setModTime(Date time)
Set this entry's modification time.
|
void | setName(String name)
Set this entry's name.
|
void | setNames(String userName, 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(String userName)
Set this entry's user name.
|
void | writeEntryHeader(byte[] outbuf)
Write an entry's header information to a header buffer.
|
Parameters: name the entry name
Parameters: name the entry name linkFlag the entry link flag.
Parameters: file The file that the entry represents.
Parameters: headerBuf The header bytes from a tar archive entry.
Parameters: it Entry to be checked for equality.
Returns: True if the entries are equal.
Parameters: it Entry to be checked for equality.
Returns: True if the entries are equal.
Returns: An array of TarEntry's for this entry's children.
Returns: This entry's file.
Returns: This entry's group id.
Returns: This entry's group name.
Returns: This entry's link name.
Returns: This entry's mode.
Returns: time This entry's new modification time.
Returns: This entry's name.
Returns: This entry's file size.
Returns: This entry's user id.
Returns: This entry's user name.
Returns: the entry hashcode
Parameters: desc Entry to be checked as a descendent of this.
Returns: True if entry is a descendant of this.
Returns: True if this entry is a directory.
Returns: true if this is a long name extension provided by GNU tar
Parameters: header The tar entry header buffer to get information from.
Parameters: groupId This entry's new group id.
Parameters: groupName This entry's new group name.
Parameters: userId This entry's new user id. groupId This entry's new group id.
Parameters: mode the mode for this entry
Parameters: time This entry's new modification time.
Parameters: time This entry's new modification time.
Parameters: name This entry's new name.
Parameters: userName This entry's new user name. groupName This entry's new group name.
Parameters: size This entry's new file size.
Parameters: userId This entry's new user id.
Parameters: userName This entry's new user name.
Parameters: outbuf The tar entry header buffer to fill in.