Package org.apache.tools.tar
Class TarInputStream
java.lang.Object
java.io.InputStream
java.io.FilterInputStream
org.apache.tools.tar.TarInputStream
- All Implemented Interfaces:
Closeable
,AutoCloseable
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().
-
Field Summary
Modifier and TypeFieldDescriptionprotected TarBuffer
protected TarEntry
protected boolean
protected long
protected long
protected boolean
protected byte[]
This contents of this array is not used at all in this class, it is only here to avoid repeated object creation during calls to the no-arg read method.protected byte[]
Fields inherited from class java.io.FilterInputStream
in
-
Constructor Summary
ConstructorDescriptionConstructor for TarInputStream.TarInputStream
(InputStream is, int blockSize) Constructor for TarInputStream.TarInputStream
(InputStream is, int blockSize, int recordSize) Constructor for TarInputStream.TarInputStream
(InputStream is, int blockSize, int recordSize, String encoding) Constructor for TarInputStream.TarInputStream
(InputStream is, int blockSize, String encoding) Constructor for TarInputStream.TarInputStream
(InputStream is, String encoding) Constructor for TarInputStream. -
Method Summary
Modifier and TypeMethodDescriptionint
Get the available data that can be read from the current entry in the archive.boolean
Whether this class is able to read the given entry.void
close()
Closes this stream.void
Copies the contents of the current tar archive entry directly into an output stream.protected byte[]
Get the next entry in this tar archive as longname data.Get the next entry in this tar archive.int
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
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[] buf, int offset, int numToRead) 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.long
skip
(long numToSkip) Skip bytes in the input buffer.Methods inherited from class java.io.FilterInputStream
read
Methods inherited from class java.io.InputStream
nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo
-
Field Details
-
debug
protected boolean debug -
hasHitEOF
protected boolean hasHitEOF -
entrySize
protected long entrySize -
entryOffset
protected long entryOffset -
readBuf
protected byte[] readBuf -
buffer
-
currEntry
-
oneBuf
protected byte[] oneBufThis contents of this array is not used at all in this class, it is only here to avoid repeated object creation during calls to the no-arg read method.
-
-
Constructor Details
-
TarInputStream
Constructor for TarInputStream.- Parameters:
is
- the input stream to use
-
TarInputStream
Constructor for TarInputStream.- Parameters:
is
- the input stream to useencoding
- name of the encoding to use for file names
-
TarInputStream
Constructor for TarInputStream.- Parameters:
is
- the input stream to useblockSize
- the block size to use
-
TarInputStream
Constructor for TarInputStream.- Parameters:
is
- the input stream to useblockSize
- the block size to useencoding
- name of the encoding to use for file names
-
TarInputStream
Constructor for TarInputStream.- Parameters:
is
- the input stream to useblockSize
- the block size to userecordSize
- the record size to use
-
TarInputStream
Constructor for TarInputStream.- Parameters:
is
- the input stream to useblockSize
- the block size to userecordSize
- the record size to useencoding
- name of the encoding to use for file names
-
-
Method Details
-
setDebug
public void setDebug(boolean debug) Sets the debugging flag.- Parameters:
debug
- True to turn on debugging.
-
close
Closes this stream. Calls the TarBuffer's close() method.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classFilterInputStream
- Throws:
IOException
- on error
-
getRecordSize
public int getRecordSize()Get the record size being used by this stream's TarBuffer.- Returns:
- The TarBuffer record size.
-
available
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. Integer.MAX_VALUE is returned in case more than Integer.MAX_VALUE bytes are left in the current entry in the archive.- Overrides:
available
in classFilterInputStream
- Returns:
- The number of available bytes for the current entry.
- Throws:
IOException
- for signature
-
skip
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.- Overrides:
skip
in classFilterInputStream
- Parameters:
numToSkip
- The number of bytes to skip.- Returns:
- the number actually skipped
- Throws:
IOException
- on error
-
markSupported
public boolean markSupported()Since we do not support marking just yet, we return false.- Overrides:
markSupported
in classFilterInputStream
- Returns:
- False.
-
mark
public void mark(int markLimit) Since we do not support marking just yet, we do nothing.- Overrides:
mark
in classFilterInputStream
- Parameters:
markLimit
- The limit to mark.
-
reset
public void reset()Since we do not support marking just yet, we do nothing.- Overrides:
reset
in classFilterInputStream
-
getNextEntry
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
- on error
-
getLongNameData
Get the next entry in this tar archive as longname data.- Returns:
- The next entry in the archive as longname data, or null.
- Throws:
IOException
- on error
-
read
Reads a byte from the current tar archive entry. This method simply calls read(byte[], int, int).- Overrides:
read
in classFilterInputStream
- Returns:
- The byte read, or -1 at EOF.
- Throws:
IOException
- on error
-
read
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 classFilterInputStream
- Parameters:
buf
- The buffer into which to place bytes read.offset
- The offset at which to place bytes read.numToRead
- The number of bytes to read.- Returns:
- The number of bytes read, or -1 at EOF.
- Throws:
IOException
- on error
-
copyEntryContents
Copies the contents of the current tar archive entry directly into an output stream.- Parameters:
out
- The OutputStream into which to write the entry's data.- Throws:
IOException
- on error
-
canReadEntryData
Whether this class is able to read the given entry.May return false if the current entry is a sparse file.
- Parameters:
te
- TarEntry- Returns:
- boolean
-