Top Description Methods
org.apache.hc.core5.http.nio.support.classic

public Interface ContentInputBuffer

Known Direct Implementers
org.apache.hc.core5.http.nio.support.classic.SharedInputBuffer
Imports
java.io.IOException

Generic content input buffer.
Since
4.0

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

data length
length
()

Return length data stored in the buffer

public int

Returns:

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.
read
(byte[]
the buffer into which the data is read.
b
,
int
the start offset in array b at which the data is written.
off
,
int
the maximum number of bytes to read.
len
)

Reads up to len bytes of data from this buffer into an array of bytes.

public int

Returns:

one byte
read
()

Reads one byte from this buffer.

public void
reset()

Resets the buffer by clearing its state and stored content.

Method Detail

lengthback to summary
public int length()

Return length data stored in the buffer

Returns:int

data length

readback to summary
public int read(byte[] b, int off, int len) throws IOException

Reads up to len bytes of data from this buffer into an array of bytes. The exact number of bytes read depends how many bytes are stored in the buffer.

If off is negative, or len is negative, or off+len is greater than the length of the array b, this method can throw a runtime exception. The exact type of runtime exception thrown by this method depends on implementation. This method returns -1 if the end of content stream has been reached.

Parameters
b:byte[]

the buffer into which the data is read.

off:int

the start offset in array b at which the data is written.

len:int

the maximum number of bytes to read.

Returns:int

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.

Exceptions
IOException:
if an I/O error occurs.
readback to summary
public int read() throws IOException

Reads one byte from this buffer. If the buffer is empty this method can throw a runtime exception. The exact type of runtime exception thrown by this method depends on implementation. This method returns -1 if the end of content stream has been reached.

Returns:int

one byte

resetback to summary
public void reset()

Resets the buffer by clearing its state and stored content.