TarEntry (Plexus Archiver Component 2.4 API)

java.lang.Object
- org.codehaus.plexus.archiver.tar.TarEntry

All Implemented Interfaces:

ArchiveFile.Entry, TarConstants

Direct Known Subclasses:

PosixTarEntry
```
public class TarEntry
extends Object
implements TarConstants, ArchiveFile.Entry
```
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;
 
```
Version:

$Revision$ $Date$ from org.apache.ant.tools.tar.TarEntry v1.22

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`checkSum` The entry's checksum.
`static int`	`DEFAULT_DIR_MODE` Default permissions bits for directories
`static int`	`DEFAULT_FILE_MODE` Default permissions bits for files
`protected int`	`devMajor` The entry's major device number.
`protected int`	`devMinor` The entry's minor device number.
`protected File`	`file` The entry's file reference
`protected int`	`groupId` The entry's group id.
`protected StringBuffer`	`groupName` The entry's group name.
`protected byte`	`linkFlag` The entry's link flag.
`protected StringBuffer`	`linkName` The entry's link name.
`protected StringBuffer`	`magic` The entry's magic tag.
`static int`	`MAX_NAMELEN` Maximum length of a user's name in the tar file
`static int`	`MILLIS_PER_SECOND` Convert millis to seconds
`protected int`	`mode` The entry's permission mode.
`protected long`	`modTime` The entry's modification time.
`protected StringBuffer`	`name` The entry's name.
`protected long`	`size` The entry's size.
`protected int`	`userId` The entry's user id.
`protected StringBuffer`	`userName` The entry's user name.

Fields inherited from interface org.codehaus.plexus.archiver.tar.TarConstants
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, MODELEN, MODTIMELEN, NAMELEN, POSIX_MAGICLEN, POSIX_PREFIXLEN, POSIX_TMAGIC, POSIX_VERSION, POSIX_VERSIONLEN, SIZELEN, TMAGIC, UIDLEN, UNAMELEN

Constructor Summary

Constructors
Constructor and Description
`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.
`TarEntry(String name, byte linkFlag)` Construct an entry with a name an a link flag.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object it)` Determine if the two entries are equal.
`boolean`	`equals(TarEntry it)` Determine if the two entries are equal.
`int`	`getChecksum()` Get this entry's checksum time.
`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.
`long`	`getLastModificationTime()` Returns the time of the entries last modification.
`String`	`getLinkName()` Get this entry's link name.
`int`	`getMode()` Get this entry's mode.
`Date`	`getModTime()` Get 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(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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - name
```
protected StringBuffer name
```
    The entry's name.
  - mode
```
protected int mode
```
    The entry's permission mode.
  - userId
```
protected int userId
```
    The entry's user id.
  - groupId
```
protected int groupId
```
    The entry's group id.
  - size
```
protected long size
```
    The entry's size.
  - modTime
```
protected long modTime
```
    The entry's modification time.
  - checkSum
```
protected int checkSum
```
    The entry's checksum.
  - linkFlag
```
protected byte linkFlag
```
    The entry's link flag.
  - linkName
```
protected StringBuffer linkName
```
    The entry's link name.
  - magic
```
protected StringBuffer magic
```
    The entry's magic tag.
  - userName
```
protected StringBuffer userName
```
    The entry's user name.
  - groupName
```
protected StringBuffer groupName
```
    The entry's group name.
  - devMajor
```
protected int devMajor
```
    The entry's major device number.
  - devMinor
```
protected int devMinor
```
    The entry's minor device number.
  - file
```
protected File file
```
    The entry's file reference
  - MAX_NAMELEN
```
public static final int MAX_NAMELEN
```
    Maximum length of a user's name in the tar file
    
    See Also:
    Constant Field Values
  - DEFAULT_DIR_MODE
```
public static final int DEFAULT_DIR_MODE
```
    Default permissions bits for directories
    
    See Also:
    Constant Field Values
  - DEFAULT_FILE_MODE
```
public static final int DEFAULT_FILE_MODE
```
    Default permissions bits for files
    
    See Also:
    Constant Field Values
  - MILLIS_PER_SECOND
```
public static final int MILLIS_PER_SECOND
```
    Convert millis to seconds
    
    See Also:
    Constant Field Values
- Constructor Detail
  - TarEntry
```
public TarEntry(String name)
```
    Construct an entry with only a name. This allows the programmer to construct the entry's header "by hand". File is set to null.
    
    Parameters:
    name - the entry name
  - TarEntry
```
public TarEntry(String name,
        byte linkFlag)
```
    Construct an entry with a name an a link flag.
    
    Parameters:
    name - the entry name
    linkFlag - the entry link flag.
  - TarEntry
```
public TarEntry(File file)
```
    Construct an entry for a file. File is set to file, and the header is constructed from information from the file.
    
    Parameters:
    file - The file that the entry represents.
  - TarEntry
```
public TarEntry(byte[] headerBuf)
```
    Construct an entry from an archive's header bytes. File is set to null.
    
    Parameters:
    headerBuf - The header bytes from a tar archive entry.
- Method Detail
  - equals
```
public boolean equals(TarEntry it)
```
    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.
  - equals
```
public boolean equals(Object it)
```
    Determine if the two entries are equal. Equality is determined by the header names being equal.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    it - Entry to be checked for equality.
    
    Returns:
    True if the entries are equal.
  - hashCode
```
public int hashCode()
```
    Hashcodes are based on entry names.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    the entry hashcode
  - isDescendent
```
public boolean isDescendent(TarEntry desc)
```
    Determine if 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 descendant of this.
    
    Returns:
    True if entry is a descendant of this.
  - getName
```
public String getName()
```
    Get this entry's name.
    
    Specified by:
    
    getName in interface ArchiveFile.Entry
    
    Returns:
    This entry's name.
  - setName
```
public void setName(String name)
```
    Set this entry's name.
    
    Parameters:
    name - This entry's new name.
  - setMode
```
public void setMode(int mode)
```
    Set the mode for this entry
    
    Parameters:
    mode - the mode for this entry
  - getLinkName
```
public String getLinkName()
```
    Get this entry's link name.
    
    Returns:
    This entry's link name.
  - getUserId
```
public int getUserId()
```
    Get this entry's user id.
    
    Returns:
    This entry's user id.
  - setUserId
```
public void setUserId(int userId)
```
    Set this entry's user id.
    
    Parameters:
    userId - This entry's new user id.
  - getGroupId
```
public int getGroupId()
```
    Get this entry's group id.
    
    Returns:
    This entry's group id.
  - setGroupId
```
public void setGroupId(int groupId)
```
    Set this entry's group id.
    
    Parameters:
    groupId - This entry's new group id.
  - getUserName
```
public String getUserName()
```
    Get this entry's user name.
    
    Returns:
    This entry's user name.
  - setUserName
```
public void setUserName(String userName)
```
    Set this entry's user name.
    
    Parameters:
    userName - This entry's new user name.
  - getGroupName
```
public String getGroupName()
```
    Get this entry's group name.
    
    Returns:
    This entry's group name.
  - setGroupName
```
public void setGroupName(String groupName)
```
    Set this entry's group name.
    
    Parameters:
    groupName - This entry's new group name.
  - setIds
```
public void setIds(int userId,
          int groupId)
```
    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.
  - setNames
```
public void setNames(String userName,
            String groupName)
```
    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.
  - setModTime
```
public void setModTime(long time)
```
    Set this entry's modification time. The parameter passed to this method is in "Java time".
    
    Parameters:
    time - This entry's new modification time.
  - setModTime
```
public void setModTime(Date time)
```
    Set this entry's modification time.
    
    Parameters:
    time - This entry's new modification time.
  - getModTime
```
public Date getModTime()
```
    Get this entry's modification time.
    
    Returns:
    time This entry's new modification time.
  - getChecksum
```
public int getChecksum()
```
    Get this entry's checksum time.
    
    Returns:
    time This entry's new modification time.
  - getFile
```
public File getFile()
```
    Get this entry's file.
    
    Returns:
    This entry's file.
  - getMode
```
public int getMode()
```
    Get this entry's mode.
    
    Returns:
    This entry's mode.
  - getSize
```
public long getSize()
```
    Get this entry's file size.
    
    Specified by:
    
    getSize in interface ArchiveFile.Entry
    
    Returns:
    This entry's file size.
  - setSize
```
public void setSize(long size)
```
    Set this entry's file size.
    
    Parameters:
    size - This entry's new file size.
  - isGNULongNameEntry
```
public boolean isGNULongNameEntry()
```
    Indicate if this entry is a GNU long name block
    
    Returns:
    true if this is a long name extension provided by GNU tar
  - isDirectory
```
public boolean isDirectory()
```
    Return whether or not this entry represents a directory.
    
    Specified by:
    
    isDirectory in interface ArchiveFile.Entry
    
    Returns:
    True if this entry is a directory.
  - getDirectoryEntries
```
public TarEntry[] getDirectoryEntries()
```
    If this entry represents a file, and the file is a directory, return an array of TarEntries for this entry's children.
    
    Returns:
    An array of TarEntry's for this entry's children.
  - writeEntryHeader
```
public void writeEntryHeader(byte[] outbuf)
```
    Write an entry's header information to a header buffer.
    
    Parameters:
    outbuf - The tar entry header buffer to fill in.
  - parseTarHeader
```
public void parseTarHeader(byte[] header)
```
    Parse an entry's header information from a header buffer.
    
    Parameters:
    header - The tar entry header buffer to get information from.
  - getLastModificationTime
```
public long getLastModificationTime()
```
    Description copied from interface: ArchiveFile.Entry
    
    Returns the time of the entries last modification.
    
    Specified by:
    
    getLastModificationTime in interface ArchiveFile.Entry
    
    Returns:
    Modification time, or -1, if unknown.

Class TarEntry

Field Summary

Fields inherited from interface org.codehaus.plexus.archiver.tar.TarConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

mode

userId

groupId

size

modTime

checkSum

linkFlag

linkName

magic

userName

groupName

devMajor

devMinor

file

MAX_NAMELEN

DEFAULT_DIR_MODE

DEFAULT_FILE_MODE

MILLIS_PER_SECOND

Constructor Detail

TarEntry

TarEntry

TarEntry

TarEntry

Method Detail

equals

equals

hashCode

isDescendent

getName

setName

setMode

getLinkName

getUserId

setUserId

getGroupId

setGroupId

getUserName

setUserName

getGroupName

setGroupName

setIds

setNames

setModTime

setModTime

getModTime

getChecksum

getFile

getMode

getSize

setSize

isGNULongNameEntry

isDirectory

getDirectoryEntries

writeEntryHeader

parseTarHeader

getLastModificationTime