de.schlichtherle.truezip.socket

Class InputSocket<E extends Entry>

java.lang.Object

de.schlichtherle.truezip.socket.IOSocket<E,Entry>

de.schlichtherle.truezip.socket.InputSocket<E>

Type Parameters:

E - the type of the local target for I/O operations.

Direct Known Subclasses:

DelegatingInputSocket, HttpInputSocket

@NotThreadSafe
public abstract class InputSocket<E extends Entry>
extends IOSocket<E,Entry>

An abstract factory for input resources for reading bytes from its local target.

Note that the entity relationship between input sockets and output sockets is n:1, i.e. any input socket can have at most one peer output socket, but it may be the peer of many other output sockets.

Author:

Christian Schlichtherle

See Also:

OutputSocket

Constructor Summary

Constructors

Constructor and Description
InputSocket()

Method Summary

Modifier and Type	Method and Description
InputSocket<E>	bind(InputSocket<?> to) Binds this socket to given socket by inheriting its peer target.
Entry	getPeerTarget() Returns the peer target for I/O operations.
InputStream	newInputStream() Returns a new input stream for reading bytes from the local target.
abstract ReadOnlyFile	newReadOnlyFile() Optional: Returns a new read only file for reading bytes from the local target in arbitrary order.
SeekableByteChannel	newSeekableByteChannel() Optional: Returns a new seekable byte channel for reading bytes from the local target in arbitrary order.

Methods inherited from class de.schlichtherle.truezip.socket.IOSocket

copy, equals, getLocalTarget, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InputSocket

public InputSocket()

Method Detail

bind

public final InputSocket<E> bind(InputSocket<?> to)

Binds this socket to given socket by inheriting its peer target. Note that this method does not change the state of the given socket and does not connect this socket to the peer socket, that is it does not set this socket as the peer of of the given socket.

Parameters:

to - the input socket with the peer target to inherit.

Returns:

this

Throws:

IllegalArgumentException - if this == to.

getPeerTarget

@Nullable
public final Entry getPeerTarget()
                                    throws IOException

Returns the peer target for I/O operations.

The same considerations as for IOSocket.getLocalTarget() apply here, too.

The peer target is null if and only if this socket is not connect(de.schlichtherle.truezip.socket.OutputSocket<?>)ed to another socket.

Specified by:

getPeerTarget in class IOSocket<E extends Entry,Entry>

Returns:

The peer target for I/O operations.

Throws:

IOException - On any I/O failure.

newInputStream

@CreatesObligation
public InputStream newInputStream()
                                              throws IOException

Returns a new input stream for reading bytes from the local target.

Implementations must enable calling this method any number of times. Furthermore, the returned input stream should not be buffered. Buffering should be addressed by the caller instead - see IOSocket.copy(de.schlichtherle.truezip.socket.InputSocket<?>, de.schlichtherle.truezip.socket.OutputSocket<?>).

The implementation in the class InputSocket calls newReadOnlyFile() and wraps the resulting object in a new ReadOnlyFileInputStream as an adapter. Note that this may violate the contract for this method because newReadOnlyFile() is allowed to throw an UnsupportedOperationException while this method is not!

Returns:

A new input stream.

Throws:

IOException - On any I/O failure.

newReadOnlyFile

@CreatesObligation
public abstract ReadOnlyFile newReadOnlyFile()
                                                         throws IOException

Optional: Returns a new read only file for reading bytes from the local target in arbitrary order.

If this method is supported, implementations must enable calling it any number of times. Furthermore, the returned read only file should not be buffered. Buffering should be addressed by client applications instead.

Returns:

A new read only file.

Throws:

IOException - On any I/O failure.

UnsupportedOperationException - if this operation is not supported by the implementation.

newSeekableByteChannel

@CreatesObligation
public SeekableByteChannel newSeekableByteChannel()
                                                              throws IOException

Optional: Returns a new seekable byte channel for reading bytes from the local target in arbitrary order.

If this method is supported, implementations must enable calling it any number of times. Furthermore, the returned seekable byte channel should not be buffered. Buffering should be addressed by client applications instead.

Returns:

A new seekable byte channel.

Throws:

IOException - On any I/O failure.

UnsupportedOperationException - if this operation is not supported by the implementation.

Since:

TrueZIP 7.2