de.schlichtherle.truezip.rof

Class DecoratingReadOnlyFile

java.lang.Object

de.schlichtherle.truezip.rof.AbstractReadOnlyFile

de.schlichtherle.truezip.rof.DecoratingReadOnlyFile

All Implemented Interfaces:

ReadOnlyFile, Closeable, AutoCloseable

Direct Known Subclasses:

BufferedReadOnlyFile, CipherReadOnlyFile, DisconnectingReadOnlyFile, IntervalReadOnlyFile, LockReadOnlyFile

@NotThreadSafe
public abstract class DecoratingReadOnlyFile
extends AbstractReadOnlyFile

An abstract decorator for a read only file.

Note that sub-classes of this class may implement their own virtual file pointer. Thus, if you would like to use the decorated read only file again after you have finished using the decorating read only file, then you should not assume a particular position of the file pointer of the decorated read only file.

Author:

Christian Schlichtherle

Field Summary

Fields

Modifier and Type	Field and Description
protected ReadOnlyFile	delegate The nullable decorated read only file.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DecoratingReadOnlyFile(ReadOnlyFile delegate) Constructs a new decorating read only file.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this read-only file and releases any non-heap resources allocated for it.
long	getFilePointer() Returns the current byte position in the file as a zero-based index.
long	length() Returns the length of the file in bytes.
int	read() Reads and returns the next byte or -1 if the end of the file has been reached.
int	read(byte[] b, int off, int len) Reads up to len bytes of data from this read only file into the given array.
void	seek(long pos) Sets the current byte position in the file as a zero-based index at which the next read occurs.
String	toString() Returns a string representation of this object for debugging and logging purposes.

Methods inherited from class de.schlichtherle.truezip.rof.AbstractReadOnlyFile

read, readFully, readFully

Methods inherited from class java.lang.Object

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

Field Detail

delegate

@Nullable
protected ReadOnlyFile delegate

The nullable decorated read only file.

Constructor Detail

DecoratingReadOnlyFile

@CreatesObligation
protected DecoratingReadOnlyFile(@Nullable @WillCloseWhenClosed
                                                    ReadOnlyFile delegate)

Constructs a new decorating read only file.

Parameters:

delegate - the nullable read only file to decorate.

Method Detail

close

public void close()
           throws IOException

Description copied from interface: ReadOnlyFile

Closes this read-only file and releases any non-heap resources allocated for it.

Throws:

IOException - On any I/O failure.

getFilePointer

public long getFilePointer()
                    throws IOException

Description copied from interface: ReadOnlyFile

Returns the current byte position in the file as a zero-based index.

Returns:

The current byte position in the file as a zero-based index.

Throws:

IOException - On any I/O failure.

length

public long length()
            throws IOException

Description copied from interface: ReadOnlyFile

Returns the length of the file in bytes.

Returns:

The length of the file in bytes.

Throws:

IOException - On any I/O failure.

read

public int read()
         throws IOException

Description copied from interface: ReadOnlyFile

Reads and returns the next byte or -1 if the end of the file has been reached.

Returns:

The next byte or -1 if the end of the file has been reached.

Throws:

IOException - On any I/O failure.

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Description copied from interface: ReadOnlyFile

Reads up to len bytes of data from this read only file into the given array. This method blocks until at least one byte of input is available unless len is zero.

Parameters:

b - The buffer to fill with data.

off - The start offset of the data.

len - The maximum number of bytes to read.

Returns:

The total number of bytes read, or -1 if there is no more data because the end of the file has been reached.

Throws:

IOException - On any I/O failure.

seek

public void seek(long pos)
          throws IOException

Description copied from interface: ReadOnlyFile

Sets the current byte position in the file as a zero-based index at which the next read occurs. Whether the offset may be set beyond the end of the file is up to the implementor. For example, the constructor of the class DefaultReadOnlyFile passes "r" as a parameter to the constructor of its super-class RandomAccessFile. With Oracle's JSE implementation, on the Windows platform this implementation allows to seek past the end of file, but on the Linux platform it doesn't.

Parameters:

pos - The current byte position as a zero-based index.

Throws:

IOException - If pos is less than 0 or on any I/O failure.

toString

public String toString()

Returns a string representation of this object for debugging and logging purposes.

Overrides:

toString in class Object