org.apache.commons.compress.archivers.tar
Class TarInputStream

java.lang.Object
  java.io.InputStream
      java.io.FilterInputStream
          org.apache.commons.compress.archivers.tar.TarInputStream

All Implemented Interfaces:

Closeable

public final class TarInputStream
extends FilterInputStream

The TarInputStream reads a UNIX tar archive as an InputStream. methods are provided to position at each successive entry in the archive, and the read each entry as a normal input stream using read().

Version:

$Revision: 155439 $ $Date: 2008-07-05 20:15:52 -0400 (Sat, 05 Jul 2008) $

Author:

Timothy Gerard Endres, Stefano Mazzocchi, Peter Donald

See Also:

TarInputStream, TarEntry

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

TarInputStream(InputStream input)
Construct a TarInputStream using specified input stream and default block and record sizes.

TarInputStream(InputStream input, int blockSize)
Construct a TarInputStream using specified input stream, block size and default record sizes.

TarInputStream(InputStream input, int blockSize, int recordSize)
Construct a TarInputStream using specified input stream, block size and record sizes.

Method Summary

int	available() Get the available data that can be read from the current entry in the archive.
void	close() Closes this stream.
void	copyEntryContents(OutputStream output) Copies the contents of the current tar archive entry directly into an output stream.
protected void	debug(String message) Utility method to do debugging.
TarEntry	getNextEntry() Get the next entry in this tar archive.
int	getRecordSize() Get the record size being used by this stream's TarBuffer.
void	mark(int markLimit) Since we do not support marking just yet, we do nothing.
boolean	markSupported() Since we do not support marking just yet, we return false.
int	read() Reads a byte from the current tar archive entry.
int	read(byte[] buffer) Reads bytes from the current tar archive entry.
int	read(byte[] buffer, int offset, int count) Reads bytes from the current tar archive entry.
void	reset() Since we do not support marking just yet, we do nothing.
void	setDebug(boolean debug) Sets the debugging flag.
void	skip(int numToSkip) Skip bytes in the input buffer.

Methods inherited from class java.io.FilterInputStream

skip

Methods inherited from class java.lang.Object

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

Constructor Detail

TarInputStream

public TarInputStream(InputStream input)

Construct a TarInputStream using specified input stream and default block and record sizes.

Parameters:

input - stream to create TarInputStream from

See Also:

TarBuffer.DEFAULT_BLOCKSIZE, TarBuffer.DEFAULT_RECORDSIZE

TarInputStream

public TarInputStream(InputStream input,
                      int blockSize)

Construct a TarInputStream using specified input stream, block size and default record sizes.

Parameters:

input - stream to create TarInputStream from

blockSize - the block size to use

See Also:

TarBuffer.DEFAULT_RECORDSIZE

TarInputStream

public TarInputStream(InputStream input,
                      int blockSize,
                      int recordSize)

Construct a TarInputStream using specified input stream, block size and record sizes.

Parameters:

input - stream to create TarInputStream from

blockSize - the block size to use

recordSize - the record size to use

Method Detail

setDebug

public void setDebug(boolean debug)

Sets the debugging flag.

Parameters:

debug - The new Debug value

getNextEntry

public TarEntry getNextEntry()
                      throws IOException

Get the next entry in this tar archive. This will skip over any remaining data in the current entry, if there is one, and place the input stream at the header of the next entry, and read the header and instantiate a new TarEntry from the header bytes and return that entry. If there are no more entries in the archive, null will be returned to indicate that the end of the archive has been reached.

Returns:

The next TarEntry in the archive, or null.

Throws:

IOException - Description of Exception

getRecordSize

public int getRecordSize()

Get the record size being used by this stream's TarBuffer.

Returns:

The TarBuffer record size.

available

public int available()
              throws IOException

Get the available data that can be read from the current entry in the archive. This does not indicate how much data is left in the entire archive, only in the current entry. This value is determined from the entry's size header field and the amount of data already read from the current entry.

Overrides:

available in class FilterInputStream

Returns:

The number of available bytes for the current entry.

Throws:

IOException - when an IO error causes operation to fail

close

public void close()
           throws IOException

Closes this stream. Calls the TarBuffer's close() method.

Specified by:

close in interface Closeable

Overrides:

close in class FilterInputStream

Throws:

IOException - when an IO error causes operation to fail

copyEntryContents

public void copyEntryContents(OutputStream output)
                       throws IOException

Copies the contents of the current tar archive entry directly into an output stream.

Parameters:

output - The OutputStream into which to write the entry's data.

Throws:

IOException - when an IO error causes operation to fail

mark

public void mark(int markLimit)

Since we do not support marking just yet, we do nothing.

Overrides:

mark in class FilterInputStream

Parameters:

markLimit - The limit to mark.

markSupported

public boolean markSupported()

Since we do not support marking just yet, we return false.

Overrides:

markSupported in class FilterInputStream

Returns:

False.

read

public int read()
         throws IOException

Reads a byte from the current tar archive entry. This method simply calls read( byte[], int, int ).

Overrides:

read in class FilterInputStream

Returns:

The byte read, or -1 at EOF.

Throws:

IOException - when an IO error causes operation to fail

read

public int read(byte[] buffer)
         throws IOException

Reads bytes from the current tar archive entry. This method simply calls read( byte[], int, int ).

Overrides:

read in class FilterInputStream

Parameters:

buffer - The buffer into which to place bytes read.

Returns:

The number of bytes read, or -1 at EOF.

Throws:

IOException - when an IO error causes operation to fail

read

public int read(byte[] buffer,
                int offset,
                int count)
         throws IOException

Reads bytes from the current tar archive entry. This method is aware of the boundaries of the current entry in the archive and will deal with them as if they were this stream's start and EOF.

Overrides:

read in class FilterInputStream

Parameters:

buffer - The buffer into which to place bytes read.

offset - The offset at which to place bytes read.

count - The number of bytes to read.

Returns:

The number of bytes read, or -1 at EOF.

Throws:

IOException - when an IO error causes operation to fail

reset

public void reset()

Since we do not support marking just yet, we do nothing.

Overrides:

reset in class FilterInputStream

skip

public void skip(int numToSkip)
          throws IOException

Skip bytes in the input buffer. This skips bytes in the current entry's data, not the entire archive, and will stop at the end of the current entry's data if the number to skip extends beyond that point.

Parameters:

numToSkip - The number of bytes to skip.

Throws:

IOException - when an IO error causes operation to fail

debug

protected void debug(String message)

Utility method to do debugging. Capable of being overidden in sub-classes.

Parameters:

message - the message to use in debugging