org.apache.commons.crypto.stream.input

? StreamInput

java.lang.Object

org.apache.commons.crypto.stream.input.StreamInput

????????:

Input

public class StreamInput
extends Object
implements Input

The StreamInput class takes a InputStream object and wraps it as Input object acceptable by CryptoInputStream.

?????

???

??????
StreamInput(InputStream inputStream, int bufferSize) Constructs a StreamInput.

????

??????	?????
int	available() Overrides the Input.available().
void	close() Overrides the Input.seek(long).
int	read(ByteBuffer dst) Overrides the Input.read(ByteBuffer).
int	read(long position, byte[] buffer, int offset, int length) Overrides the Input.read(long, byte[], int, int) .
void	seek(long position) Overrides the Input.seek(long).
long	skip(long n) Overrides the Input.skip(long).

??????? java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

???????

StreamInput

public StreamInput(InputStream inputStream,
                   int bufferSize)

Constructs a StreamInput.

??:

inputStream - the inputstream object.

bufferSize - the buffersize.

??????

read

public int read(ByteBuffer dst)
         throws IOException

Overrides the Input.read(ByteBuffer). Reads a sequence of bytes from input into the given buffer.

???:

read ???? Input

??:

dst - The buffer into which bytes are to be transferred.

??:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

??:

IOException - if an I/O error occurs.

skip

public long skip(long n)
          throws IOException

Overrides the Input.skip(long). Skips over and discards n bytes of data from this input stream.

???:

skip ???? Input

??:

n - the number of bytes to be skipped.

??:

the actual number of bytes skipped.

??:

IOException - if an I/O error occurs.

available

public int available()
              throws IOException

Overrides the Input.available(). Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream. The next invocation might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

???:

available ???? Input

??:

an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or 0 when it reaches the end of the input stream.

??:

IOException - if an I/O error occurs.

read

public int read(long position,
                byte[] buffer,
                int offset,
                int length)
         throws IOException

Overrides the Input.read(long, byte[], int, int) . Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

???:

read ???? Input

??:

position - the given position within a stream.

buffer - the buffer into which the data is read.

offset - the start offset in array buffer.

length - the maximum number of bytes to read.

??:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

??:

IOException - if an I/O error occurs.

seek

public void seek(long position)
          throws IOException

Overrides the Input.seek(long). Seeks to the given offset from the start of the stream. The next read() will be from that location.

???:

seek ???? Input

??:

position - the offset from the start of the stream.

??:

IOException - if an I/O error occurs.

close

public void close()
           throws IOException

Overrides the Input.seek(long). Closes this input and releases any system resources associated with the under layer input.

???:

close ???? Input

??:

IOException - if an I/O error occurs.