Alphabetical Index

A B C D E F G H I K L M N O P R S T U V W

A

asciiTranslate - field in class com.ice.tar.TarArchive
assemBuf - field in class com.ice.tar.TarOutputStream
assemLen - field in class com.ice.tar.TarOutputStream
available() - method in class com.ice.tar.TarInputStream
Get the available data that can be read from the current entry in the archive.

B

buffer - field in class com.ice.tar.TarInputStream
buffer - field in class com.ice.tar.TarOutputStream

C

checkSum - field in class com.ice.tar.TarHeader
The entry's checksum.
CHKSUMLEN - static field in class com.ice.tar.TarHeader
The length of the checksum field in a header buffer.
clone() - method in class com.ice.tar.TarEntry
Clone the entry.
clone() - method in class com.ice.tar.TarHeader
TarHeaders can be cloned.
close() - method in class com.ice.tar.TarBuffer
Close the TarBuffer.
close() - method in class com.ice.tar.TarGzOutputStream
close() - method in class com.ice.tar.TarInputStream
Closes this stream.
close() - method in class com.ice.tar.TarOutputStream
Ends the TAR archive and closes the underlying OutputStream.
closeArchive() - method in class com.ice.tar.TarArchive
Close the archive.
closeEntry() - method in class com.ice.tar.TarGzOutputStream
closeEntry() - method in class com.ice.tar.TarOutputStream
Close an entry.
com.ice.tar - package
Implements support for UNIX tar archives.
computeCheckSum(byte[]) - method in class com.ice.tar.TarEntry
Compute the checksum of a tar entry header.
copyEntryContents(OutputStream) - method in class com.ice.tar.TarInputStream
Copies the contents of the current tar archive entry directly into an output stream.
createEntry(byte[]) - method in class com.ice.tar.TarInputStream.EntryAdapter
createEntry(byte[]) - method in class com.ice.tar.TarInputStream.EntryFactory
createEntry(File) - method in class com.ice.tar.TarInputStream.EntryAdapter
createEntry(File) - method in class com.ice.tar.TarInputStream.EntryFactory
createEntry(String) - method in class com.ice.tar.TarInputStream.EntryAdapter
createEntry(String) - method in class com.ice.tar.TarInputStream.EntryFactory
currBytes - field in class com.ice.tar.TarOutputStream
currEntry - field in class com.ice.tar.TarInputStream
currSize - field in class com.ice.tar.TarOutputStream

D

debug - field in class com.ice.tar.TarArchive
debug - field in class com.ice.tar.TarInputStream
debug - field in class com.ice.tar.TarOutputStream
DEFAULT_BLKSIZE - static field in class com.ice.tar.TarBuffer
DEFAULT_RCDSIZE - static field in class com.ice.tar.TarBuffer
DEVLEN - static field in class com.ice.tar.TarHeader
The length of the devices field in a header buffer.
devMajor - field in class com.ice.tar.TarHeader
The entry's major device number.
devMinor - field in class com.ice.tar.TarHeader
The entry's minor device number.

E

eFactory - field in class com.ice.tar.TarInputStream
This interface is provided, with the method setEntryFactory(), to allow the programmer to have their own TarEntry subclass instantiated for the entries return from getNextEntry().
entryOffset - field in class com.ice.tar.TarInputStream
entrySize - field in class com.ice.tar.TarInputStream
equals(com.ice.tar.TarEntry) - method in class com.ice.tar.TarEntry
Determine if the two entries are equal.
extractContents(File) - method in class com.ice.tar.TarArchive
Perform the "extract" command and extract the contents of the archive.

F

FastTarStream - class com.ice.tar.FastTarStream
Special class designed to parse a Tar archive VERY FAST.
FastTarStream(InputStream) - constructor for class com.ice.tar.FastTarStream
FastTarStream(InputStream,int) - constructor for class com.ice.tar.FastTarStream
file - field in class com.ice.tar.TarEntry
If this entry represents a File, this references it.
finish() - method in class com.ice.tar.TarGzOutputStream
finish() - method in class com.ice.tar.TarOutputStream
Ends the TAR archive without closing the underlying OutputStream.

G

getBlockSize() - method in class com.ice.tar.TarBuffer
Get the TAR Buffer's block size.
getCheckSumOctalBytes(long,byte[],int,int) - static method in class com.ice.tar.TarHeader
Parse the checksum octal integer from a header buffer.
getCurrentBlockNum() - method in class com.ice.tar.TarBuffer
Get the current block number, zero based.
getCurrentRecordNum() - method in class com.ice.tar.TarBuffer
Get the current record number, within the current block, zero based.
getDirectoryEntries() - method in class com.ice.tar.TarEntry
If this entry represents a file, and the file is a directory, return an array of TarEntries for this entry's children.
getEntryPosition() - method in class com.ice.tar.TarInputStream
Get the number of bytes into the current TarEntry.
getFile() - method in class com.ice.tar.TarEntry
Get this entry's file.
getFileNameBytes(String,byte[]) - static method in class com.ice.tar.TarHeader
This method, like getNameBytes(), is intended to place a name into a TarHeader's buffer.
Fill in a TarHeader with information from a File.
getGroupId() - method in class com.ice.tar.TarArchive
Get the group id being used for archive entry headers.
getGroupId() - method in class com.ice.tar.TarEntry
Get this entry's group id.
getGroupName() - method in class com.ice.tar.TarArchive
Get the group name being used for archive entry headers.
getGroupName() - method in class com.ice.tar.TarEntry
Get this entry's group name.
getHeader() - method in class com.ice.tar.TarEntry
Get this entry's header.
getLongOctalBytes(long,byte[],int,int) - static method in class com.ice.tar.TarHeader
Parse an octal long integer from a header buffer.
getModTime() - method in class com.ice.tar.TarEntry
Set this entry's modification time.
getName() - method in class com.ice.tar.TarEntry
Get this entry's name.
getName() - method in class com.ice.tar.TarHeader
Get the name of this entry.
getNameBytes(StringBuffer,byte[],int,int) - static method in class com.ice.tar.TarHeader
Move the bytes from the name StringBuffer into the header's buffer.
getNextEntry() - method in class com.ice.tar.FastTarStream
getNextEntry() - method in class com.ice.tar.TarInputStream
Get the next entry in this tar archive.
getOctalBytes(long,byte[],int,int) - static method in class com.ice.tar.TarHeader
Parse an octal integer from a header buffer.
getRecordSize() - method in class com.ice.tar.TarArchive
Get the archive's record size.
getRecordSize() - method in class com.ice.tar.TarBuffer
Get the TAR Buffer's record size.
getRecordSize() - method in class com.ice.tar.TarGzOutputStream
getRecordSize() - method in class com.ice.tar.TarInputStream
Get the record size being used by this stream's TarBuffer.
getRecordSize() - method in class com.ice.tar.TarOutputStream
Get the record size being used by this stream's TarBuffer.
getSize() - method in class com.ice.tar.TarEntry
Get this entry's file size.
getStreamPosition() - method in class com.ice.tar.TarInputStream
Get the number of bytes into the stream we are currently at.
getTempDirectory() - method in class com.ice.tar.TarArchive
Get the current temporary directory path.
getUserId() - method in class com.ice.tar.TarArchive
Get the user id being used for archive entry headers.
getUserId() - method in class com.ice.tar.TarEntry
Get this entry's user id.
getUserName() - method in class com.ice.tar.TarArchive
Get the user name being used for archive entry headers.
getUserName() - method in class com.ice.tar.TarEntry
Get this entry's user name.
GIDLEN - static field in class com.ice.tar.TarHeader
The length of the group id field in a header buffer.
GNAMELEN - static field in class com.ice.tar.TarHeader
The length of the group name field in a header buffer.
GNU_TMAGIC - static field in class com.ice.tar.TarHeader
The magic tag representing a GNU tar archive.
gnuFormat - field in class com.ice.tar.TarEntry
Set to true if this is a GNU 'ustar' format entry.
groupId - field in class com.ice.tar.TarArchive
groupId - field in class com.ice.tar.TarHeader
The entry's group id.
groupName - field in class com.ice.tar.TarArchive
groupName - field in class com.ice.tar.TarHeader
The entry's group name.

H

hasHitEOF - field in class com.ice.tar.TarInputStream
hasMoreElements() - method in class com.ice.tar.TarEntryEnumerator
Return true if there are more elements in the enumeration.
header - field in class com.ice.tar.TarEntry
This is the entry's header information.

I

instanceMain(argv[]) - method in class com.ice.tar.tar
This is the "real" main.
This exception is used to indicate that there is a problem with a TAR archive header.
InvalidHeaderException() - constructor for class com.ice.tar.InvalidHeaderException
InvalidHeaderException(String) - constructor for class com.ice.tar.InvalidHeaderException
isAsciiFile(File) - method in class com.ice.tar.TarTransFileTyper
Return true if the file should be translated as ASCII.
isAsciiFile(String) - method in class com.ice.tar.TarTransFileTyper
Return true if the file should be translated as ASCII based on its name.
isDescendent(com.ice.tar.TarEntry) - method in class com.ice.tar.TarEntry
Determine if the given entry is a descendant of this entry.
isDirectory() - method in class com.ice.tar.TarEntry
Return whether or not this entry represents a directory.
isEOFRecord(byte[]) - method in class com.ice.tar.TarBuffer
Determine if an archive record indicate End of Archive.
isGNUTarFormat() - method in class com.ice.tar.TarEntry
Returns true if this entry's header is in the GNU 'ustar' format.
isUnixTarFormat() - method in class com.ice.tar.TarEntry
Returns true if this entry's header is in the old "unix-tar" format.
isUSTarFormat() - method in class com.ice.tar.TarEntry
Returns true if this entry's header is in "ustar" format.
isVerbose() - method in class com.ice.tar.TarArchive
Returns the verbosity setting.

K

keepOldFiles - field in class com.ice.tar.TarArchive

L

LF_BLK - static field in class com.ice.tar.TarHeader
Block device file type.
LF_CHR - static field in class com.ice.tar.TarHeader
Character device file type.
LF_CONTIG - static field in class com.ice.tar.TarHeader
Contiguous file type.
LF_DIR - static field in class com.ice.tar.TarHeader
Directory file type.
LF_FIFO - static field in class com.ice.tar.TarHeader
FIFO (pipe) file type.
LF_LINK - static field in class com.ice.tar.TarHeader
Link file type.
LF_NORMAL - static field in class com.ice.tar.TarHeader
Normal file type.
LF_OLDNORM - static field in class com.ice.tar.TarHeader
LF_ constants represent the "link flag" of an entry, or more commonly, the "entry type".
LF_SYMLINK - static field in class com.ice.tar.TarHeader
Symbolic link file type.
linkFlag - field in class com.ice.tar.TarHeader
The entry's link flag.
linkName - field in class com.ice.tar.TarHeader
The entry's link name.
listContents() - method in class com.ice.tar.TarArchive
Perform the "list" command and list the contents of the archive.

M

magic - field in class com.ice.tar.TarHeader
The entry's magic tag.
MAGICLEN - static field in class com.ice.tar.TarHeader
The length of the magic field in a header buffer.
main(argv[]) - static method in class com.ice.tar.tar
The main entry point of the tar class.
main(String[]) - static method in class com.ice.tar.FastTarStream
mark(int) - method in class com.ice.tar.TarInputStream
Since we do not support marking just yet, we do nothing.
markSupported() - method in class com.ice.tar.TarInputStream
Since we do not support marking just yet, we return false.
mode - field in class com.ice.tar.TarHeader
The entry's permission mode.
MODELEN - static field in class com.ice.tar.TarHeader
The length of the mode field in a header buffer.
modTime - field in class com.ice.tar.TarHeader
The entry's modification time.
MODTIMELEN - static field in class com.ice.tar.TarHeader
The length of the modification time field in a header buffer.

N

name - field in class com.ice.tar.TarHeader
The entry's name.
NAMELEN - static field in class com.ice.tar.TarHeader
The length of the name field in a header buffer.
NAMEOFFSET - static field in class com.ice.tar.TarHeader
The offset of the name field in a header buffer.
Fill in a TarHeader given only the entry's name.
nextElement() - method in class com.ice.tar.TarEntryEnumerator
Return the next element in the enumeration.

O

oneBuf - field in class com.ice.tar.TarInputStream
oneBuf - field in class com.ice.tar.TarOutputStream

P

parseFileName(byte[]) - static method in class com.ice.tar.TarHeader
Parse a file name from a header buffer.
parseName(byte[],int,int) - static method in class com.ice.tar.TarHeader
Parse an entry name from a header buffer.
parseOctal(byte[],int,int) - static method in class com.ice.tar.TarHeader
Parse an octal string from a header buffer.
Parse an entry's TarHeader information from a header buffer.
pathPrefix - field in class com.ice.tar.TarArchive
PREFIXLEN - static field in class com.ice.tar.TarHeader
The length of the name prefix field in a header buffer.
PREFIXOFFSET - static field in class com.ice.tar.TarHeader
The offset of the name prefix field in a header buffer.
progressDisplay - field in class com.ice.tar.TarArchive
Put an entry on the output stream.

R

read() - method in class com.ice.tar.TarInputStream
Reads a byte from the current tar archive entry.
read(byte[]) - method in class com.ice.tar.TarInputStream
Reads bytes from the current tar archive entry.
read(byte[],int,int) - method in class com.ice.tar.TarInputStream
Reads bytes from the current tar archive entry.
readBuf - field in class com.ice.tar.TarInputStream
readRecord() - method in class com.ice.tar.TarBuffer
Read a record from the input stream and return the data.
recordBuf - field in class com.ice.tar.TarArchive
recordBuf - field in class com.ice.tar.TarOutputStream
recordSize - field in class com.ice.tar.TarArchive
reset() - method in class com.ice.tar.TarInputStream
Since we do not support marking just yet, we do nothing.
rootPath - field in class com.ice.tar.TarArchive

S

setAsciiTranslation(boolean) - method in class com.ice.tar.TarArchive
Set the ascii file translation flag.
setBufferDebug(boolean) - method in class com.ice.tar.TarGzOutputStream
setBufferDebug(boolean) - method in class com.ice.tar.TarInputStream
Sets the debugging flag in this stream's TarBuffer.
setBufferDebug(boolean) - method in class com.ice.tar.TarOutputStream
Sets the debugging flag in this stream's TarBuffer.
setDebug(boolean) - method in class com.ice.tar.FastTarStream
setDebug(boolean) - method in class com.ice.tar.TarArchive
Set the debugging flag.
setDebug(boolean) - method in class com.ice.tar.TarBuffer
Set the debugging flag for the buffer.
setDebug(boolean) - method in class com.ice.tar.TarGzOutputStream
setDebug(boolean) - method in class com.ice.tar.TarInputStream
Sets the debugging flag.
setDebug(boolean) - method in class com.ice.tar.TarOutputStream
Sets the debugging flag.
Sets the debugging flag.
setGNUTarFormat() - method in class com.ice.tar.TarEntry
Sets this entry's header format to GNU "ustar".
setGroupId(int) - method in class com.ice.tar.TarEntry
Set this entry's group id.
setGroupName(String) - method in class com.ice.tar.TarEntry
Set this entry's group name.
setIds(int,int) - method in class com.ice.tar.TarEntry
Convenience method to set this entry's group and user ids.
setKeepOldFiles(boolean) - method in class com.ice.tar.TarArchive
Set the flag that determines whether existing files are kept, or overwritten during extraction.
setModTime(Date) - method in class com.ice.tar.TarEntry
Set this entry's modification time.
setModTime(long) - method in class com.ice.tar.TarEntry
Set this entry's modification time.
setName(String) - method in class com.ice.tar.TarEntry
Set this entry's name.
setNames(String,String) - method in class com.ice.tar.TarEntry
Convenience method to set this entry's group and user names.
setSize(long) - method in class com.ice.tar.TarEntry
Set this entry's file size.
Set the current progress display interface.
setTempDirectory(String) - method in class com.ice.tar.TarArchive
Set the current temporary directory path.
Set the object that will determine if a file is of type ascii text for translation purposes.
setUnixTarFormat() - method in class com.ice.tar.TarEntry
Sets this entry's header format to "unix-style".
setUserId(int) - method in class com.ice.tar.TarEntry
Set this entry's user id.
setUserInfo(int,String,int,String) - method in class com.ice.tar.TarArchive
Set user and group information that will be used to fill in the tar archive's entry headers.
setUserName(String) - method in class com.ice.tar.TarEntry
Set this entry's user name.
setUSTarFormat() - method in class com.ice.tar.TarEntry
Sets this entry's header format to "ustar".
setVerbose(boolean) - method in class com.ice.tar.TarArchive
Set the verbosity flag.
showTarProgressMessage(String) - method in class com.ice.tar.tar
Display progress information by printing it to System.out.
Display a progress message.
size - field in class com.ice.tar.TarHeader
The entry's size.
SIZELEN - static field in class com.ice.tar.TarHeader
The length of the size field in a header buffer.
skip(long) - method in class com.ice.tar.TarInputStream
Skip bytes in the input buffer.
skipRecord() - method in class com.ice.tar.TarBuffer
Skip over a record on the input stream.

T

tar - class com.ice.tar.tar
The tar class implements a weak reproduction of the traditional UNIX tar command.
tar() - constructor for class com.ice.tar.tar
Establishes the default userName with the 'user.name' property.
TarArchive - class com.ice.tar.TarArchive
The TarArchive class implements the concept of a tar archive.
TarArchive(InputStream) - constructor for class com.ice.tar.TarArchive
The InputStream based constructors create a TarArchive for the purposes of e'x'tracting or lis't'ing a tar archive.
TarArchive(InputStream,int) - constructor for class com.ice.tar.TarArchive
TarArchive(InputStream,int,int) - constructor for class com.ice.tar.TarArchive
TarArchive(OutputStream) - constructor for class com.ice.tar.TarArchive
The OutputStream based constructors create a TarArchive for the purposes of 'c'reating a tar archive.
TarArchive(OutputStream,int) - constructor for class com.ice.tar.TarArchive
TarArchive(OutputStream,int,int) - constructor for class com.ice.tar.TarArchive
TarBuffer - class com.ice.tar.TarBuffer
The TarBuffer class implements the tar archive concept of a buffered input stream.
TarBuffer(InputStream) - constructor for class com.ice.tar.TarBuffer
TarBuffer(InputStream,int) - constructor for class com.ice.tar.TarBuffer
TarBuffer(InputStream,int,int) - constructor for class com.ice.tar.TarBuffer
TarBuffer(OutputStream) - constructor for class com.ice.tar.TarBuffer
TarBuffer(OutputStream,int) - constructor for class com.ice.tar.TarBuffer
TarBuffer(OutputStream,int,int) - constructor for class com.ice.tar.TarBuffer
TarEntry - class com.ice.tar.TarEntry
This class represents an entry in a Tar archive.
TarEntry() - constructor for class com.ice.tar.TarEntry
The default constructor is protected for use only by subclasses.
TarEntry(byte[]) - constructor for class com.ice.tar.TarEntry
Construct an entry from an archive's header bytes.
TarEntry(File) - constructor for class com.ice.tar.TarEntry
Construct an entry for a file.
TarEntry(String) - constructor for class com.ice.tar.TarEntry
Construct an entry with only a name.
Enumerate the contents of a "tar" file.
Construct an instance given a TarInputStream.
Outputs tar.gz files.
TarGzOutputStream(OutputStream) - constructor for class com.ice.tar.TarGzOutputStream
TarHeader - class com.ice.tar.TarHeader
This class encapsulates the Tar Entry Header used in Tar Archives.
TarHeader() - constructor for class com.ice.tar.TarHeader
tarIn - field in class com.ice.tar.TarArchive
TarInputStream - class com.ice.tar.TarInputStream
The TarInputStream reads a UNIX tar archive as an InputStream.
TarInputStream(InputStream) - constructor for class com.ice.tar.TarInputStream
TarInputStream(InputStream,int) - constructor for class com.ice.tar.TarInputStream
TarInputStream(InputStream,int,int) - constructor for class com.ice.tar.TarInputStream
tarOut - field in class com.ice.tar.TarArchive
TarOutputStream - class com.ice.tar.TarOutputStream
The TarOutputStream writes a UNIX tar archive as an OutputStream.
TarOutputStream(OutputStream) - constructor for class com.ice.tar.TarOutputStream
TarOutputStream(OutputStream,int) - constructor for class com.ice.tar.TarOutputStream
TarOutputStream(OutputStream,int,int) - constructor for class com.ice.tar.TarOutputStream
TarProgressDisplay - interface com.ice.tar.TarProgressDisplay
This interface is provided to TarArchive to display progress information during operation.
This interface indicates if a file qualifies for ASCII translation.
tempPath - field in class com.ice.tar.TarArchive
TMAGIC - static field in class com.ice.tar.TarHeader
The magic tag representing a POSIX tar archive.
toString() - method in class com.ice.tar.TarEntry
transTyper - field in class com.ice.tar.TarArchive

U

UIDLEN - static field in class com.ice.tar.TarHeader
The length of the user id field in a header buffer.
UNAMELEN - static field in class com.ice.tar.TarHeader
The length of the user name field in a header buffer.
unixFormat - field in class com.ice.tar.TarEntry
Set to true if this is a "old-unix" format entry.
userId - field in class com.ice.tar.TarArchive
userId - field in class com.ice.tar.TarHeader
The entry's user id.
userName - field in class com.ice.tar.TarArchive
userName - field in class com.ice.tar.TarHeader
The entry's user name.
ustarFormat - field in class com.ice.tar.TarEntry
Set to true if this is a 'ustar' format entry.

V

verbose - field in class com.ice.tar.TarArchive

W

write(byte[]) - method in class com.ice.tar.TarGzOutputStream
write(byte[]) - method in class com.ice.tar.TarOutputStream
Writes bytes to the current tar archive entry.
write(byte[],int,int) - method in class com.ice.tar.TarGzOutputStream
write(byte[],int,int) - method in class com.ice.tar.TarOutputStream
Writes bytes to the current tar archive entry.
write(int) - method in class com.ice.tar.TarGzOutputStream
write(int) - method in class com.ice.tar.TarOutputStream
Writes a byte to the current tar archive entry.
Write an entry to the archive.
writeEntryHeader(byte[]) - method in class com.ice.tar.TarEntry
Write an entry's header information to a header buffer.
writeRecord(byte[]) - method in class com.ice.tar.TarBuffer
Write an archive record to the archive.
writeRecord(byte[],int) - method in class com.ice.tar.TarBuffer
Write an archive record to the archive, where the record may be inside of a larger array buffer.

This software has been placed into the public domain.