E
- the type of the local target
.@NotThreadSafe public abstract class ClutchInputSocket<E extends Entry> extends DelegatingInputSocket<E>
ClutchOutputSocket
Constructor and Description |
---|
ClutchInputSocket() |
Modifier and Type | Method and Description |
---|---|
protected InputSocket<? extends E> |
getDelegate()
Returns the delegate socket.
|
protected abstract InputSocket<? extends E> |
getLazyDelegate()
Returns the delegate socket for lazy initialization.
|
E |
getLocalTarget()
Returns the local target for I/O operations.
|
InputStream |
newInputStream()
Returns a new input stream for reading bytes from the
local target . |
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. |
protected void |
reset() |
getBoundSocket
bind, getPeerTarget
protected final InputSocket<? extends E> getDelegate() throws IOException
DelegatingInputSocket
getDelegate
in class DelegatingInputSocket<E extends Entry>
IOException
- On any I/O failure.protected abstract InputSocket<? extends E> getLazyDelegate() throws IOException
IOException
- on any I/O failure.public E getLocalTarget() throws IOException
IOSocket
Note that this interface contract does not state any other
terms or conditions for the returned object.
In particular, clients need to consider that multiple invocations of
this method could return different objects (e.g. defensive copies) which
may even fail the Object.equals(java.lang.Object)
test.
On the other hand, implementations need to consider that clients could
attempt to change the state of the returned object in arbitrary manner.
Consequently, the result of doing so is undefined, too.
In particular, a subsequent I/O operation may not reflect the change
or may even fail.
Sub-interfaces or implementations may add additional terms and
conditions in order to resolve these potential issues.
getLocalTarget
in class DelegatingInputSocket<E extends Entry>
IOException
- On any I/O failure.public InputStream newInputStream() throws IOException
InputSocket
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
InputSocket.newReadOnlyFile()
and wraps the resulting object in a new
ReadOnlyFileInputStream
as an adapter.
Note that this may violate the contract for this method because
InputSocket.newReadOnlyFile()
is allowed to throw an
UnsupportedOperationException
while this method is not!
newInputStream
in class DelegatingInputSocket<E extends Entry>
IOException
- On any I/O failure.public ReadOnlyFile newReadOnlyFile() throws IOException
InputSocket
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.
newReadOnlyFile
in class DelegatingInputSocket<E extends Entry>
IOException
- On any I/O failure.public SeekableByteChannel newSeekableByteChannel() throws IOException
InputSocket
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.
newSeekableByteChannel
in class DelegatingInputSocket<E extends Entry>
IOException
- On any I/O failure.protected final void reset()
Copyright © 2005–2018 Schlichtherle IT Services. All rights reserved.