org.eclipse.rse.services.clientserver.archiveutils
Class TarEntry

java.lang.Object
  org.eclipse.rse.services.clientserver.archiveutils.TarEntry

All Implemented Interfaces:

java.lang.Cloneable

public class TarEntry
extends java.lang.Object
implements java.lang.Cloneable

This class represents a tar file entry.

Since:

3.0

Field Summary

byte[]	chksum
byte[]	devmajor
byte[]	devminor
byte[]	gid
byte[]	gname
byte[]	linkname
byte[]	magic
byte[]	mode
byte[]	mtime
byte[]	name
byte[]	prefix
byte[]	size
byte	typeflag
byte[]	uid
byte[]	uname
byte[]	version

Constructor Summary

TarEntry(java.lang.String name)
Creates a new tar entry with the specified name.

Method Summary

void	calculateChecksum() Calculates the checksum of the entry.
java.lang.Object	clone()
long	getChecksum() Gets the checksum.
java.lang.String	getDevMajor() Gets the major device number in octal.
java.lang.String	getDevMinor() Gets the minor device number in octal.
java.lang.String	getGID() Gets the gid in octal.
java.lang.String	getGroupName() Gets the group name.
java.lang.String	getLinkName() Gets the link name.
java.lang.String	getMagic() Returns whether the archive was output in the P1003 archive format.
java.lang.String	getMode() Gets the mode in octal.
long	getModificationTime() Gets the modification time, in milliseconds since 00:00:00 GMT, January 1, 1970.
java.lang.String	getName() Gets the name.
java.lang.String	getPrefix() Gets the prefix in octal.
long	getSize() Gets the size in bytes.
char	getTypeFlag() Gets the type of file archived.
java.lang.String	getUID() Gets the uid in octal.
java.lang.String	getUserName() Gets the user name.
java.lang.String	getVersion() Gets the version in octal.
boolean	isDirectory() Returns whether the entry represents a directory.
void	setModificationTime(long modTime) Sets the modification time.
void	setName(java.lang.String fileName) Sets the name of the tar entry.
void	setSize(long fileSize) Sets the file size in bytes.
void	setUserMode(boolean canRead, boolean canWrite, boolean canExecute) Sets the user mod.
void	setUserName(java.lang.String userName) Sets the user name of the tar entry.
void	writeFields(java.io.OutputStream outStream) Write the fields to the given output stream.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

public byte[] name

mode

public byte[] mode

uid

public byte[] uid

gid

public byte[] gid

size

public byte[] size

mtime

public byte[] mtime

chksum

public byte[] chksum

typeflag

public byte typeflag

linkname

public byte[] linkname

magic

public byte[] magic

version

public byte[] version

uname

public byte[] uname

gname

public byte[] gname

devmajor

public byte[] devmajor

devminor

public byte[] devminor

prefix

public byte[] prefix

Constructor Detail

TarEntry

public TarEntry(java.lang.String name)

Creates a new tar entry with the specified name. Use the setter methods to populate the other fields of the entry.

Parameters:

name - the name of the tar entry.

Throws:

java.lang.NullPointerException - if the name is null.

java.lang.IllegalArgumentException - if the length of the name is greater that

Method Detail

setName

public void setName(java.lang.String fileName)

Sets the name of the tar entry.

Parameters:

fileName - the name for the tar entry.

Throws:

java.lang.NullPointerException - if the name is null.

getName

public java.lang.String getName()

Gets the name.

Returns:

the name.

setUserMode

public void setUserMode(boolean canRead,
                        boolean canWrite,
                        boolean canExecute)

Sets the user mod.

Parameters:

canRead - true if the user has read permission, false otherwise.

canWrite - true if the user has write permission, false otherwise.

canExecute - true if the user has execute permission, false otherwise.

getMode

public java.lang.String getMode()

Gets the mode in octal.

Returns:

the mode.

getUID

public java.lang.String getUID()

Gets the uid in octal.

Returns:

the uid.

getGID

public java.lang.String getGID()

Gets the gid in octal.

Returns:

the gid.

setSize

public void setSize(long fileSize)

Sets the file size in bytes.

Parameters:

fileSize - the file size.

getSize

public long getSize()

Gets the size in bytes.

Returns:

the size.

setModificationTime

public void setModificationTime(long modTime)

Sets the modification time.

Parameters:

modTime - the modification time, in milliseconds since 00:00:00 GMT, January 1, 1970.

getModificationTime

public long getModificationTime()

Gets the modification time, in milliseconds since 00:00:00 GMT, January 1, 1970.

Returns:

the modification time.

getChecksum

public long getChecksum()

Gets the checksum.

Returns:

the checksum.

getTypeFlag

public char getTypeFlag()

Gets the type of file archived.

Returns:

the type flag.

getLinkName

public java.lang.String getLinkName()

Gets the link name.

Returns:

the link name.

getMagic

public java.lang.String getMagic()

Returns whether the archive was output in the P1003 archive format. This is not used.

Returns:

the magic field.

getVersion

public java.lang.String getVersion()

Gets the version in octal.

Returns:

the version.

setUserName

public void setUserName(java.lang.String userName)

Sets the user name of the tar entry.

Parameters:

userName - the user name for the tar entry.

Throws:

java.lang.NullPointerException - if the user name is null.

getUserName

public java.lang.String getUserName()

Gets the user name.

Returns:

the user name.

getGroupName

public java.lang.String getGroupName()

Gets the group name.

Returns:

the group name.

getDevMajor

public java.lang.String getDevMajor()

Gets the major device number in octal.

Returns:

the major device number.

getDevMinor

public java.lang.String getDevMinor()

Gets the minor device number in octal.

Returns:

the minor device number.

getPrefix

public java.lang.String getPrefix()

Gets the prefix in octal.

Returns:

the prefix.

isDirectory

public boolean isDirectory()

Returns whether the entry represents a directory.

Returns:

true if the entry represents a directory, false otherwise.

writeFields

public void writeFields(java.io.OutputStream outStream)
                 throws java.io.IOException

Write the fields to the given output stream.

Parameters:

outStream - the output stream to write to.

Throws:

java.io.IOException

calculateChecksum

public void calculateChecksum()

Calculates the checksum of the entry.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

See Also:

Object.clone()