net.java.truecommons.cio

Class AbstractOutputSocket<E extends Entry>

java.lang.Object

net.java.truecommons.shed.UniqueObject

net.java.truecommons.cio.AbstractIoSocket<E>

net.java.truecommons.cio.AbstractOutputSocket<E>

Type Parameters:

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

All Implemented Interfaces:

IoSocket<E>, OutputSocket<E>

Direct Known Subclasses:

DelegatingOutputSocket

@Immutable
public abstract class AbstractOutputSocket<E extends Entry>
extends AbstractIoSocket<E>
implements OutputSocket<E>

Abstract base class for output sockets.

Subclasses should be immutable.

Author:

Christian Schlichtherle

See Also:

AbstractInputSocket

Constructor Summary

Constructors

Constructor and Description
AbstractOutputSocket()

Method Summary

Modifier and Type	Method and Description
SeekableByteChannel	channel(InputSocket<? extends Entry> peer) Optional operation: Returns a new seekable byte channel for writing bytes.
OutputStream	stream(InputSocket<? extends Entry> peer) Returns a new output stream for writing bytes.
protected static <E extends Entry> E	target(InputSocket<E> peer) Returns the target of the given nullable peer socket or null.

Methods inherited from class net.java.truecommons.cio.AbstractIoSocket

toString

Methods inherited from class net.java.truecommons.shed.UniqueObject

equals, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.java.truecommons.cio.IoSocket

target

Constructor Detail

AbstractOutputSocket

public AbstractOutputSocket()

Method Detail

channel

public SeekableByteChannel channel(InputSocket<? extends Entry> peer)
                            throws IOException

Optional operation: Returns a new seekable byte channel for writing bytes. If this method is supported, then the returned seekable byte channel should not be buffered. Buffering should get addressed by the caller instead.

Because the intention of this interface is output, the returned channel may not be able to position the file pointer or read data and any attempt to do so may fail with a NonReadableChannelException.

Specified by:

channel in interface OutputSocket<E extends Entry>

Parameters:

peer - the nullable peer socket for copying entry contents.

Returns:

A new seekable byte channel for writing bytes.

Throws:

UnsupportedOperationException - the implementation in the class OutputSocket always throws an exception of this type.

IOException - on any I/O error.

stream

public OutputStream stream(InputSocket<? extends Entry> peer)
                    throws IOException

Returns a new output stream for writing bytes. The returned output stream should not be buffered. Buffering should get addressed by the caller instead.

The implementation in the class OutputSocket calls channel(net.java.truecommons.cio.InputSocket<? extends net.java.truecommons.cio.Entry>) and wraps the result in a ChannelOutputStream adapter. Note that this violates the contract for this method unless you override either this method or channel(net.java.truecommons.cio.InputSocket<? extends net.java.truecommons.cio.Entry>) with a valid implementation.

Specified by:

stream in interface OutputSocket<E extends Entry>

Parameters:

peer - the nullable peer socket for copying entry contents.

Returns:

A new output stream for writing bytes.

Throws:

IOException - on any I/O error.

target

@Nullable
protected static <E extends Entry> E target(@Nullable
                                                      InputSocket<E> peer)
                                               throws IOException

Returns the target of the given nullable peer socket or null. This method is provided for convenience.

Type Parameters:

E - the type of the peer socket's local target.

Parameters:

peer - the nullable peer socket.

Returns:

null if the given reference is null or the target of the given peer socket otherwise.

Throws:

IOException - if resolving the peer's local target fails.