ChannelOutput

java.lang.Object

org.apache.commons.crypto.stream.output.ChannelOutput

All Implemented Interfaces:: Closeable, AutoCloseable, Output

public class ChannelOutput extends Object implements Output

The ChannelOutput class takes a WritableByteChannel object and wraps it as Output object acceptable by CryptoOutputStream as the output target.

Field Summary

Fields

Modifier and Type

Field

Description

private final WritableByteChannel

channel
Constructor Summary

Constructors

Constructor

Description

ChannelOutput(WritableByteChannel channel)

Constructs a ChannelOutput.
Method Summary

Modifier and Type

Method

Description

void

close()

Overrides the Output.close().

void

flush()

Overrides the Output.flush().

int

write(ByteBuffer src)

Overrides the Output.write(ByteBuffer).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- channel
  
  private final WritableByteChannel channel
Constructor Details
- ChannelOutput
  
  public ChannelOutput(WritableByteChannel channel)
  
  Constructs a ChannelOutput.
  
  Parameters:
  
  channel - the WritableByteChannel object.
Method Details
- close
  
  public void close() throws IOException
  
  Overrides the Output.close(). Closes this output and releases any system resources associated with the under layer output.
  
  Specified by:
  
  close in interface AutoCloseable
  
  Specified by:
  
  close in interface Closeable
  
  Specified by:
  
  close in interface Output
  
  Throws:
  
  IOException - if an I/O error occurs.
- flush
  
  public void flush() throws IOException
  
  Overrides the Output.flush(). Flushes this output and forces any buffered output bytes to be written out if the under layer output method support.
  
  Specified by:
  
  flush in interface Output
  
  Throws:
  
  IOException - if an I/O error occurs.
- write
  
  public int write(ByteBuffer src) throws IOException
  
  Overrides the Output.write(ByteBuffer). Writes a sequence of bytes to this output from the given buffer.
  
  Specified by:
  
  write in interface Output
  
  Parameters:
  
  src - The buffer from which bytes are to be retrieved.
  
  Returns:
  
  The number of bytes written, possibly zero.
  
  Throws:
  
  IOException - if an I/O error occurs.