Constructor Detail

• DelegatingInputSocket

  public DelegatingInputSocket()

Method Detail

• channel

  public SeekableByteChannel channel(@Nullable
                            OutputSocket<? extends Entry> peer)
                              throws IOException

  Description copied from class: AbstractInputSocket
  Optional operation: Returns a new seekable byte channel for reading bytes. If this operation 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 input, the returned channel may not be able to write data and any attempt to do so should fail with a NonWritableChannelException.

  Specified by:

  channel in interface InputSocket<E extends Entry>

  Overrides:

  channel in class AbstractInputSocket<E extends Entry>

  Parameters:

  peer - the nullable peer socket for copying entry contents.

  Returns:

  A new seekable byte channel for reading bytes.

  Throws:

  IOException - on any I/O error.

• socket

  protected abstract InputSocket<? extends E> socket()
                                                            throws IOException

  Returns the delegate input socket.

  Returns:

  The delegate input socket.

  Throws:

  IOException - on any I/O error.

• stream

  public InputStream stream(@Nullable
                   OutputSocket<? extends Entry> peer)
                     throws IOException

  Description copied from class: AbstractInputSocket
  Returns a new input stream for reading bytes. The returned input stream should not be buffered. Buffering should get addressed by the caller instead.

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

  Specified by:

  stream in interface InputSocket<E extends Entry>

  Overrides:

  stream in class AbstractInputSocket<E extends Entry>

  Parameters:

  peer - the nullable peer socket for copying entry contents.

  Returns:

  A new input stream for reading bytes.

  Throws:

  IOException - on any I/O error.

• target

  public E target()
                         throws IOException

  Description copied from interface: IoSocket
  Resolves the target for I/O operations.

  Note that this interface contract does not state any other terms or conditions for the returned entry. In particular, the returned object may or may not be a defensive copy and it may or may not reflect the effect of subsequent I/O operations. So a client may only assume that the returned entry accurately reflects the state of its represented entity before the client does subsequent I/O. Implementations may add some constraints to ease the situation for clients.

  Returns:

  The local target for I/O operations.

  Throws:

  IOException - on any I/O error.