|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectinstaller.TarEntry
This class represents an entry in a Tar archive. It consists of the entry's header, as well as the entry's File. Entries can be instantiated in one of three ways, depending on how they are to be used.
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;
TarHeader
Field Summary | |
protected File |
file
If this entry represents a File, this references it. |
protected TarHeader |
header
This is the entry's header information. |
Constructor Summary | |
TarEntry(byte[] headerBuf)
Construct an entry from an archive's header bytes. |
|
TarEntry(File file)
Construct an entry for a file. |
|
TarEntry(String name)
Construct an entry with only a name. |
Method Summary | |
void |
adjustEntryName(byte[] outbuf,
String newName)
Convenience method that will modify an entry's name directly in place in an entry header buffer byte array. |
long |
computeCheckSum(byte[] buf)
Compute the checksum of a tar entry header. |
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. |
File |
getFile()
Get this entry's file. |
void |
getFileTarHeader(TarHeader hdr,
File file)
Fill in a TarHeader with information from a File. |
int |
getGroupId()
Get this entry's group id. |
String |
getGroupName()
Get this entry's group name. |
TarHeader |
getHeader()
Get this entry's header. |
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. |
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. |
void |
nameTarHeader(TarHeader hdr,
String name)
Fill in a TarHeader given only the entry's name. |
void |
parseTarHeader(TarHeader hdr,
byte[] header)
Parse an entry's TarHeader 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 |
setModTime(Date time)
Set this entry's modification time. |
void |
setModTime(long 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. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected File file
protected TarHeader header
Constructor Detail |
public TarEntry(String name)
public TarEntry(File file) throws InvalidHeaderException
file
- The file that the entry represents.public TarEntry(byte[] headerBuf) throws InvalidHeaderException
headerBuf
- The header bytes from a tar archive entry.Method Detail |
public boolean equals(TarEntry it)
public boolean isDescendent(TarEntry desc)
desc
- Entry to be checked as a descendent of this.
public TarHeader getHeader()
public String getName()
public void setName(String name)
name
- This entry's new name.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 String getUserName()
public void setUserName(String userName)
userName
- This entry's new user name.public String getGroupName()
public void setGroupName(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(String userName, 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(Date time)
time
- This entry's new modification time.public Date getModTime()
public File getFile()
public long getSize()
public void setSize(long size)
size
- This entry's new file size.public void adjustEntryName(byte[] outbuf, String newName)
outbuf
- The buffer containing the entry header to modify.newName
- The new name to place into the header buffer.public boolean isDirectory()
public void getFileTarHeader(TarHeader hdr, File file) throws InvalidHeaderException
hdr
- The TarHeader to fill in.file
- The file from which to get the header information.
InvalidHeaderException
public TarEntry[] getDirectoryEntries() throws InvalidHeaderException
InvalidHeaderException
public long computeCheckSum(byte[] buf)
buf
- The tar entry's header buffer.
public void writeEntryHeader(byte[] outbuf)
outbuf
- The tar entry header buffer to fill in.public void parseTarHeader(TarHeader hdr, byte[] header) throws InvalidHeaderException
hdr
- The TarHeader to fill in from the buffer information.header
- The tar entry header buffer to get information from.
InvalidHeaderException
public void nameTarHeader(TarHeader hdr, String name)
hdr
- The TarHeader to fill in.name
- The tar entry name.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |