java.nio

Class Buffer

public abstract class Buffer extends Object

Since: 1.4

Method Summary
int	capacity() Retrieves the capacity of the buffer.
Buffer	clear() Clears the buffer.
Buffer	flip() Flips the buffer.
boolean	hasRemaining() Tells whether the buffer has remaining data to read or not.
abstract boolean	isReadOnly() Tells whether this buffer is read only or not.
int	limit() Retrieves the current limit of the buffer.
Buffer	limit(int newLimit) Sets this buffer's limit.
Buffer	mark() Sets this buffer's mark at its position.
int	position() Retrieves the current position of this buffer.
Buffer	position(int newPosition) Sets this buffer's position.
int	remaining() Returns the number of elements between the current position and the limit.
Buffer	reset() Resets this buffer's position to the previously-marked position.
Buffer	rewind() Rewinds this buffer.

Method Detail

capacity

public final int capacity()

Retrieves the capacity of the buffer.

Returns: the capacity of the buffer

clear

public final Buffer clear()

Clears the buffer.

Returns: this buffer

flip

public final Buffer flip()

Flips the buffer.

Returns: this buffer

hasRemaining

public final boolean hasRemaining()

Tells whether the buffer has remaining data to read or not.

Returns: true if the buffer contains remaining data to read, false otherwise

isReadOnly

public abstract boolean isReadOnly()

Tells whether this buffer is read only or not.

Returns: true if the buffer is read only, false otherwise

limit

public final int limit()

Retrieves the current limit of the buffer.

Returns: the limit of the buffer

limit

public final Buffer limit(int newLimit)

Sets this buffer's limit.

Parameters: newLimit The new limit value; must be non-negative and no larger than this buffer's capacity.

Returns: this buffer

Throws: IllegalArgumentException If the preconditions on newLimit do not hold.

mark

public final Buffer mark()

Sets this buffer's mark at its position.

Returns: this buffer

position

public final int position()

Retrieves the current position of this buffer.

Returns: the current position of this buffer

position

public final Buffer position(int newPosition)

Sets this buffer's position. If the mark is defined and larger than the new position then it is discarded.

Parameters: newPosition The new position value; must be non-negative and no larger than the current limit.

Returns: this buffer

Throws: IllegalArgumentException If the preconditions on newPosition do not hold

remaining

public final int remaining()

Returns the number of elements between the current position and the limit.

Returns: the number of remaining elements

reset

public final Buffer reset()

Resets this buffer's position to the previously-marked position.

Returns: this buffer

Throws: InvalidMarkException If the mark has not been set.

rewind

public final Buffer rewind()

Rewinds this buffer. The position is set to zero and the mark is discarded.

Returns: this buffer