Field Detail

• buffer

  @CheckForNull
  volatile IOCache.Buffer buffer

Constructor Detail

• IOCache.Input

  private IOCache.Input()

Method Detail

• getBoundSocket

  protected InputSocket<? extends Entry> getBoundSocket()
                                                 throws IOException

  Description copied from class: DelegatingInputSocket
  Binds the decorated socket to this socket and returns it.

  Overrides:

  getBoundSocket in class DelegatingInputSocket<Entry>

  Returns:

  The bound decorated socket.

  Throws:

  IOException

• getDelegate

  protected InputSocket<? extends Entry> getDelegate()
                                              throws IOException

  Description copied from class: DelegatingInputSocket
  Returns the delegate socket.

  Specified by:

  getDelegate in class DelegatingInputSocket<Entry>

  Returns:

  The delegate socket.

  Throws:

  IOException

• getLocalTarget

  public Entry 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.

  Overrides:

  getLocalTarget in class DelegatingInputSocket<Entry>

  Returns:

  The local target for I/O operations.

  Throws:

  IOException

• getPeerTarget

  public Entry getPeerTarget()
                      throws IOException

  Description copied from class: InputSocket
  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 InputSocket.connect(de.schlichtherle.truezip.socket.OutputSocket<?>)ed to another socket.

  Overrides:

  getPeerTarget in class DelegatingInputSocket<Entry>

  Returns:

  The peer target for I/O operations.

  Throws:

  IOException

• newInputStream

  public InputStream newInputStream()
                             throws IOException

  Description copied from class: InputSocket
  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 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!

  Overrides:

  newInputStream in class DelegatingInputSocket<Entry>

  Returns:

  A new input stream.

  Throws:

  IOException - on any I/O error.

• newReadOnlyFile

  public ReadOnlyFile newReadOnlyFile()
                               throws IOException

  Description copied from class: InputSocket
  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.

  Overrides:

  newReadOnlyFile in class DelegatingInputSocket<Entry>

  Returns:

  A new read only file.

  Throws:

  IOException - on any I/O error.

• newSeekableByteChannel

  public SeekableByteChannel newSeekableByteChannel()
                                             throws IOException

  Description copied from class: InputSocket
  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.

  Overrides:

  newSeekableByteChannel in class DelegatingInputSocket<Entry>

  Throws:

  IOException - on any I/O error.