de.schlichtherle.truezip.socket
Class DecoratingOutputSocket<E extends Entry>

java.lang.Object
  de.schlichtherle.truezip.socket.IOSocket<E,Entry>
      de.schlichtherle.truezip.socket.OutputSocket<E>
          de.schlichtherle.truezip.socket.DecoratingOutputSocket<E>

Type Parameters:

E - The type of the local target.

Direct Known Subclasses:

FsCachingController.Cache.ProxyOutputSocket, FsCachingController.Output, FsConcurrentController.Output, FsFederatingController.Output, FsStatisticsController.Output, IOCache.Buffer.BufferOutputSocket, LazyOutputSocket

public abstract class DecoratingOutputSocket<E extends Entry>
extends OutputSocket<E>

An abstract decorator for an output socket.

Author:

Christian Schlichtherle

See Also:

DecoratingInputSocket

delegate

private final OutputSocket<? extends E extends Entry> delegate

DecoratingOutputSocket

protected DecoratingOutputSocket(@NonNull
                                 OutputSocket<? extends E> output)

getBoundSocket

protected OutputSocket<? extends E> getBoundSocket()
                                                          throws IOException

Binds the decorated socket to this socket and returns it.

Returns:

The bound decorated socket.

Throws:

IOException

getLocalTarget

public E getLocalTarget()
                               throws IOException

Description copied from class: IOSocket

Returns the local target for I/O operations.

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.

Specified by:

getLocalTarget in class IOSocket<E extends Entry,Entry>

Returns:

The local target for I/O operations.

Throws:

IOException

getPeerTarget

public Entry getPeerTarget()
                    throws IOException

Description copied from class: OutputSocket

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 OutputSocket.connect(de.schlichtherle.truezip.socket.InputSocket)ed to another socket.

Overrides:

getPeerTarget in class OutputSocket<E extends Entry>

Returns:

The peer target for I/O operations.

Throws:

IOException

newOutputStream

public OutputStream newOutputStream()
                             throws IOException

Description copied from class: OutputSocket

Returns a new output stream for writing bytes to the local target.

Implementations must enable calling this method any number of times. Furthermore, the returned output 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).

Specified by:

newOutputStream in class OutputSocket<E extends Entry>

Returns:

A new output stream.

Throws:

FileNotFoundException - if the local target is not accessible for some reason.

IOException - on any other exceptional condition.

toString

public String toString()

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

Overrides:

toString in class IOSocket<E extends Entry,Entry>