Class DeflatingStreamSinkConduit

Method Details

• transferFrom

  public long transferFrom(FileChannel src, long position, long count) throws IOException

  Description copied from interface: StreamSinkConduit

  Transfer bytes into this conduit from the given file.

  Specified by:

  transferFrom in interface StreamSinkConduit

  Overrides:

  transferFrom in class AbstractStreamSinkConduit<StreamSinkConduit>

  Parameters:

  src - the file to read from

  position - the position within the file from which the transfer is to begin

  count - the number of bytes to be transferred

  Returns:

  the number of bytes (possibly 0) that were actually transferred

  Throws:

  IOException - if an I/O error occurs

• transferFrom

  public long transferFrom(StreamSourceChannel source, long count, ByteBuffer throughBuffer) throws IOException

  Description copied from interface: StreamSinkConduit

  Transfers bytes from the given channel source. On entry, throughBuffer will be cleared. On exit, the buffer will be flipped for emptying, and may be empty or may contain data. If this method returns a value less than count, then the remaining data in throughBuffer may contain data read from source which must be written to this channel to complete the operation.

  Specified by:

  transferFrom in interface StreamSinkConduit

  Overrides:

  transferFrom in class AbstractStreamSinkConduit<StreamSinkConduit>

  Parameters:

  source - the source to read from

  count - the number of bytes to be transferred

  throughBuffer - the buffer to copy through.

  Returns:

  the number of bytes (possibly 0) that were actually transferred, or -1 if the end of input was reached

  Throws:

  IOException - if an I/O error occurs

• write

  public int write(ByteBuffer src) throws IOException

  Description copied from interface: StreamSinkConduit

  Writes a sequence of bytes to this conduit from the given buffer.

  Specified by:

  write in interface StreamSinkConduit

  Overrides:

  write in class AbstractStreamSinkConduit<StreamSinkConduit>

  Parameters:

  src - the buffer containing data to write

  Returns:

  the number of bytes written, possibly 0

  Throws:

  ClosedChannelException - if this conduit's SinkConduit.terminateWrites() method was previously called

  IOException - if an error occurs

• write

  public long write(ByteBuffer[] srcs, int offset, int length) throws IOException

  Description copied from interface: StreamSinkConduit

  Writes a sequence of bytes to this conduit from the given buffers.

  Specified by:

  write in interface StreamSinkConduit

  Overrides:

  write in class AbstractStreamSinkConduit<StreamSinkConduit>

  Parameters:

  srcs - the buffers containing data to write

  offset - the offset into the buffer array

  length - the number of buffers to write

  Returns:

  the number of bytes written, possibly 0

  Throws:

  ClosedChannelException - if this conduit's SinkConduit.terminateWrites() method was previously called

  IOException - if an error occurs

• flush

  public boolean flush() throws IOException

  Description copied from interface: SinkConduit

  Flush out any unwritten, buffered output.

  Specified by:

  flush in interface SinkConduit

  Overrides:

  flush in class AbstractSinkConduit<StreamSinkConduit>

  Returns:

  true if everything is flushed, false otherwise

  Throws:

  IOException - if flush fails

• writeFinal

  public int writeFinal(ByteBuffer src) throws IOException

  Description copied from interface: StreamSinkConduit

  Writes some data to the conduit, with the same semantics as StreamSinkConduit.write(java.nio.ByteBuffer). If all the data is written out then the conduit will have its writes terminated. Semantically this method is equivalent to: int rem = src.remaining(); int written = conduit.write(src); if(written == rem) { conduit.terminateWrites() }

  Specified by:

  writeFinal in interface StreamSinkConduit

  Overrides:

  writeFinal in class AbstractStreamSinkConduit<StreamSinkConduit>

  Parameters:

  src - The data to write

  Returns:

  The amount of data that was actually written.

  Throws:

  IOException

• writeFinal

  public long writeFinal(ByteBuffer[] srcs, int offset, int length) throws IOException

  Description copied from interface: StreamSinkConduit

  Writes some data to the conduit, with the same semantics as StreamSinkConduit.write(java.nio.ByteBuffer[], int, int). If all the data is written out then the conduit will have its writes terminated.

  Specified by:

  writeFinal in interface StreamSinkConduit

  Overrides:

  writeFinal in class AbstractStreamSinkConduit<StreamSinkConduit>

  Parameters:

  srcs - The buffers from which bytes are to be retrieved

  offset - The offset within the buffer array of the first buffer from which bytes are to be retrieved; must be non-negative and no larger than srcs.length

  length - The maximum number of buffers to be accessed; must be non-negative and no larger than srcs.length - offset

  Returns:

  The amount of data that was actually written

  Throws:

  IOException

• terminateWrites

  public void terminateWrites() throws IOException

  Description copied from interface: SinkConduit

  Signal that no more write data is forthcoming. The conduit must be SinkConduit.flush()ed before it is considered to be shut down.

  Specified by:

  terminateWrites in interface SinkConduit

  Overrides:

  terminateWrites in class AbstractSinkConduit<StreamSinkConduit>

  Throws:

  IOException

• truncateWrites

  public void truncateWrites() throws IOException

  Description copied from interface: SinkConduit

  Terminate writes and discard any outstanding write data. The conduit is terminated and flushed regardless of the outcome of this method.

  Specified by:

  truncateWrites in interface SinkConduit

  Overrides:

  truncateWrites in class AbstractSinkConduit<StreamSinkConduit>

  Throws:

  IOException - if channel termination failed for some reason