Field Detail

• name

  final FsEntryName name

• options

  final BitField<FsOutputOption> options

• template

  @CheckForNull
  final Entry template

Constructor Detail

• FsCachingController.Output

  FsCachingController.Output(FsEntryName name,
                            BitField<FsOutputOption> options,
                            @CheckForNull
                            Entry template)

Method Detail

• getBoundSocket

  public OutputSocket<?> getBoundSocket()
                                 throws IOException

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

  Overrides:

  getBoundSocket in class DecoratingOutputSocket<Entry>

  Returns:

  The bound decorated 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 DecoratingOutputSocket<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 DecoratingOutputSocket<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<?>).

  Overrides:

  newOutputStream in class DecoratingOutputSocket<Entry>

  Returns:

  A new output stream.

  Throws:

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

  IOException - on any other exceptional condition.