Summary: Methods | Inherited Methods | [Expand All]

public abstract class

ByteBuffer

extends Buffer
implements Comparable<T>

java.lang.Object
↳	java.nio.Buffer
	↳	java.nio.ByteBuffer

Known Direct Subclasses

MappedByteBuffer

Class Overview

A buffer of bytes.

A byte buffer can be created in either of the following ways:

Allocate a new byte array and create a buffer based on it;
Allocate a memory block and create a direct buffer based on it;
Wrap an existing byte array to create a new buffer.

Summary

Public Methods
static ByteBuffer	allocate(int capacity) Creates a byte buffer based on a new allocated byte array.
static ByteBuffer	allocateDirect(int capacity) Creates a direct byte buffer based on a new allocated memory block.
final byte[]	array() Returns the byte array which this buffer is based on, if there's one.
final int	arrayOffset() Returns the offset of the byte array which this buffer is based on, if there's one.
abstract CharBuffer	asCharBuffer() Returns a char buffer which is based on the remaining content of this byte buffer.
abstract DoubleBuffer	asDoubleBuffer() Returns a double buffer which is based on the remaining content of this byte buffer.
abstract FloatBuffer	asFloatBuffer() Returns a float buffer which is based on the remaining content of this byte buffer.
abstract IntBuffer	asIntBuffer() Returns a int buffer which is based on the remaining content of this byte buffer.
abstract LongBuffer	asLongBuffer() Returns a long buffer which is based on the remaining content of this byte buffer.
abstract ByteBuffer	asReadOnlyBuffer() Returns a readonly buffer that shares content with this buffer.
abstract ShortBuffer	asShortBuffer() Returns a short buffer which is based on the remaining content of this byte buffer.
abstract ByteBuffer	compact() Compacts this byte buffer.
int	compareTo(ByteBuffer otherBuffer) Compare the remaining `byte`s of this buffer to another byte buffer's remaining `byte`s.
abstract ByteBuffer	duplicate() Returns a duplicated buffer that shares content with this buffer.
boolean	equals(Object other) Tests whether this byte buffer equals to another object.
abstract byte	get() Returns the byte at the current position and increase the position by 1.
ByteBuffer	get(byte[] dest, int off, int len) Reads `byte`s from the current position into the specified byte array, starting from the specified offset, and increase the position by the number of `byte`s read.
ByteBuffer	get(byte[] dest) Reads `byte`s from the current position into the specified byte array and increase the position by the number of `byte`s read.
abstract byte	get(int index) Returns a byte at the specified index, and the position is not changed.
abstract char	getChar(int index) Returns the char at the specified index.
abstract char	getChar() Returns the char at the current position and increase the position by 2.
abstract double	getDouble() Returns the double at the current position and increase the position by 8.
abstract double	getDouble(int index) Returns the double at the specified index.
abstract float	getFloat() Returns the float at the current position and increase the position by 4.
abstract float	getFloat(int index) Returns the float at the specified index.
abstract int	getInt(int index) Returns the int at the specified index.
abstract int	getInt() Returns the int at the current position and increase the position by 4.
abstract long	getLong() Returns the long at the current position and increase the position by 8.
abstract long	getLong(int index) Returns the long at the specified index.
abstract short	getShort(int index) Returns the short at the specified index.
abstract short	getShort() Returns the short at the current position and increase the position by 2.
final boolean	hasArray() Returns whether this buffer is based on a byte array and is read/write.
int	hashCode() Hash code is calculated from the remaining `byte`s.
abstract boolean	isDirect() Returns true if this buffer is direct.
final ByteOrder	order() Returns the byte order used by this buffer when converting `byte`s from/to other primitive types.
final ByteBuffer	order(ByteOrder byteOrder) Sets the byte order of this buffer.
final ByteBuffer	put(byte[] src) Writes `byte`s in the given byte array to the current position and increase the position by the number of `byte`s written.
abstract ByteBuffer	put(byte b) Writes the given byte to the current position and increase the position by 1.
abstract ByteBuffer	put(int index, byte b) Write a byte to the specified index of this buffer and the position is not changed.
ByteBuffer	put(ByteBuffer src) Writes all the remaining `byte`s of the `src` byte buffer to this buffer's current position, and increase both buffers' position by the number of `byte`s copied.
ByteBuffer	put(byte[] src, int off, int len) Writes `byte`s in the given byte array, starting from the specified offset, to the current position and increase the position by the number of `byte`s written.
abstract ByteBuffer	putChar(int index, char value) Write a char to the specified index of this buffer.
abstract ByteBuffer	putChar(char value) Writes the given char to the current position and increase the position by 2.
abstract ByteBuffer	putDouble(int index, double value) Write a double to the specified index of this buffer.
abstract ByteBuffer	putDouble(double value) Writes the given double to the current position and increase the position by 8.
abstract ByteBuffer	putFloat(int index, float value) Write a float to the specified index of this buffer.
abstract ByteBuffer	putFloat(float value) Writes the given float to the current position and increase the position by 4.
abstract ByteBuffer	putInt(int value) Writes the given int to the current position and increase the position by 4.
abstract ByteBuffer	putInt(int index, int value) Write a int to the specified index of this buffer.
abstract ByteBuffer	putLong(long value) Writes the given long to the current position and increase the position by 8.
abstract ByteBuffer	putLong(int index, long value) Write a long to the specified index of this buffer.
abstract ByteBuffer	putShort(int index, short value) Write a short to the specified index of this buffer.
abstract ByteBuffer	putShort(short value) Writes the given short to the current position and increase the position by 2.
abstract ByteBuffer	slice() Returns a sliced buffer that shares content with this buffer.
String	toString() Returns a string represents the state of this byte buffer.
static ByteBuffer	wrap(byte[] array) Creates a new byte buffer by wrapping the given byte array.
static ByteBuffer	wrap(byte[] array, int start, int len) Creates new a byte buffer by wrapping the given byte array.

[Expand]

Inherited Methods

From class java.nio.Buffer

final int	capacity() Returns the capacity of this buffer.
final Buffer	clear() Clears this buffer.
final Buffer	flip() Flips this buffer.
final boolean	hasRemaining() Returns true if there are remaining element(s) in this buffer.
abstract boolean	isReadOnly() Returns whether this buffer is readonly or not.
final int	limit() Returns the limit of this buffer.
final Buffer	limit(int newLimit) Sets the limit of this buffer.
final Buffer	mark() Mark the current position, so that the position may return to this point later by calling `reset()`.
final int	position() Returns the position of this buffer.
final Buffer	position(int newPosition) Sets the position of this buffer.
final int	remaining() Returns the number of remaining elements in this buffer.
final Buffer	reset() Reset the position of this buffer to the `mark`.
final Buffer	rewind() Rewinds this buffer.

From class java.lang.Object

Object	clone() Returns a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o) Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
void	finalize() Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final Class<? extends Object>	getClass() Returns the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode() Returns an integer hash code for the receiver.
final void	notify() Causes one thread which is `wait` ing on the receiver to be made ready to run.
final void	notifyAll() Causes all threads which are `wait` ing on the receiver to be made ready to run.
String	toString() Returns a string containing a concise, human-readable description of the receiver.
final void	wait(long time, int frac) Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final void	wait(long time) Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final void	wait() Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

From interface java.lang.Comparable

Public Methods

public static ByteBuffer allocate (int capacity)

Creates a byte buffer based on a new allocated byte array.

Parameters

capacity	The capacity of the new buffer

Returns

The created byte buffer

Throws

IllegalArgumentException	If `capacity` is less than zero

public static ByteBuffer allocateDirect (int capacity)

Creates a direct byte buffer based on a new allocated memory block.

Parameters

capacity	The capacity of the new buffer

Returns

The created byte buffer

Throws

IllegalArgumentException	If `capacity` is less than zero

public final byte[] array ()

Returns the byte array which this buffer is based on, if there's one.

Returns

The byte array which this buffer is based on

Throws

ReadOnlyBufferException	If this buffer is based on a readonly array
UnsupportedOperationException	If this buffer is not based on an array

public final int arrayOffset ()

Returns the offset of the byte array which this buffer is based on, if there's one.

The offset is the index of the array corresponds to the zero position of the buffer.

Returns

The offset of the byte array which this buffer is based on

Throws

ReadOnlyBufferException	If this buffer is based on a readonly array
UnsupportedOperationException	If this buffer is not based on an array

public abstract CharBuffer asCharBuffer ()

Returns a char buffer which is based on the remaining content of this byte buffer.

The new buffer's position is zero, its limit and capacity is the number of remaining bytes divided by two, and its mark is not set. The new buffer's readonly property and byte order are same as this buffer. The new buffer is direct, if this byte buffer is direct.

The new buffer shares content with this buffer, which means either buffer's change of content will be visible to the other. The two buffer's position, limit and mark are independent.

Returns

A char buffer which is based on the content of this byte buffer.

public abstract DoubleBuffer asDoubleBuffer ()

Returns a double buffer which is based on the remaining content of this byte buffer.

The new buffer's position is zero, its limit and capacity is the number of remaining bytes divided by two, and its mark is not set. The new buffer's readonly property and byte order are same as this buffer. The new buffer is direct, if this byte buffer is direct.

The new buffer shares content with this buffer, which means either buffer's change of content will be visible to the other. The two buffer's position, limit and mark are independent.

Returns

A double buffer which is based on the content of this byte buffer.

public abstract FloatBuffer asFloatBuffer ()

Returns a float buffer which is based on the remaining content of this byte buffer.

The new buffer's position is zero, its limit and capacity is the number of remaining bytes divided by two, and its mark is not set. The new buffer's readonly property and byte order are same as this buffer. The new buffer is direct, if this byte buffer is direct.

The new buffer shares content with this buffer, which means either buffer's change of content will be visible to the other. The two buffer's position, limit and mark are independent.

Returns

A float buffer which is based on the content of this byte buffer.

public abstract IntBuffer asIntBuffer ()

Returns a int buffer which is based on the remaining content of this byte buffer.

The new buffer's position is zero, its limit and capacity is the number of remaining bytes divided by two, and its mark is not set. The new buffer's readonly property and byte order are same as this buffer. The new buffer is direct, if this byte buffer is direct.

The new buffer shares content with this buffer, which means either buffer's change of content will be visible to the other. The two buffer's position, limit and mark are independent.

Returns

A int buffer which is based on the content of this byte buffer.

public abstract LongBuffer asLongBuffer ()

Returns a long buffer which is based on the remaining content of this byte buffer.

The new buffer's position is zero, its limit and capacity is the number of remaining bytes divided by two, and its mark is not set. The new buffer's readonly property and byte order are same as this buffer. The new buffer is direct, if this byte buffer is direct.

The new buffer shares content with this buffer, which means either buffer's change of content will be visible to the other. The two buffer's position, limit and mark are independent.

Returns

A long buffer which is based on the content of this byte buffer.

public abstract ByteBuffer asReadOnlyBuffer ()

Returns a readonly buffer that shares content with this buffer.

The returned buffer is guaranteed to be a new instance, even this buffer is readonly itself. The new buffer's position, limit, capacity and mark are the same as this buffer.

The new buffer shares content with this buffer, which means this buffer's change of content will be visible to the new buffer. The two buffer's position, limit and mark are independent.

Returns

A readonly version of this buffer.

public abstract ShortBuffer asShortBuffer ()

Returns a short buffer which is based on the remaining content of this byte buffer.

The new buffer's position is zero, its limit and capacity is the number of remaining bytes divided by two, and its mark is not set. The new buffer's readonly property and byte order are same as this buffer. The new buffer is direct, if this byte buffer is direct.

The new buffer shares content with this buffer, which means either buffer's change of content will be visible to the other. The two buffer's position, limit and mark are independent.

Returns

A short buffer which is based on the content of this byte buffer.

public abstract ByteBuffer compact ()

Compacts this byte buffer.

The remaining bytes will be moved to the head of the buffer, staring from position zero. Then the position is set to remaining(); the limit is set to capacity; the mark is cleared.

Returns

This buffer

Throws

ReadOnlyBufferException	If no changes may be made to the contents of this buffer

public int compareTo (ByteBuffer otherBuffer)

Compare the remaining bytes of this buffer to another byte buffer's remaining bytes.

Parameters

otherBuffer	Another byte buffer

Returns

a negative value if this is less than other; 0 if this equals to other; a positive value if this is greater than other

Throws

ClassCastException	If `other` is not a byte buffer

public abstract ByteBuffer duplicate ()

Returns a duplicated buffer that shares content with this buffer.

The duplicated buffer's position, limit, capacity and mark are the same as this buffer. The duplicated buffer's readonly property and byte order are same as this buffer too.

The new buffer shares content with this buffer, which means either buffer's change of content will be visible to the other. The two buffer's position, limit and mark are independent.

Returns

A duplicated buffer that shares content with this buffer.

public boolean equals (Object other)

Tests whether this byte buffer equals to another object.

If other is not a byte buffer, then false is returned.

Two byte buffers are equals if, and only if, their remaining bytes are exactly the same. Position, limit, capacity and mark are not considered.

Parameters

other	the object to compare against

Returns

Whether this byte buffer equals to another object.

public abstract byte get ()

Returns the byte at the current position and increase the position by 1.

Returns

The byte at the current position.

Throws

BufferUnderflowException	If the position is equal or greater than limit

public ByteBuffer get (byte[] dest, int off, int len)

Reads bytes from the current position into the specified byte array, starting from the specified offset, and increase the position by the number of bytes read.

Parameters

dest	The target byte array
off	The offset of the byte array, must be no less than zero and no greater than `dest.length`
len	The number of `byte`s to read, must be no less than zero and no greater than `dest.length - off`

Returns

This buffer

Throws

IndexOutOfBoundsException	If either `off` or `len` is invalid
BufferUnderflowException	If `len` is greater than `remaining()`

public ByteBuffer get (byte[] dest)

Reads bytes from the current position into the specified byte array and increase the position by the number of bytes read.

Calling this method has the same effect as get(dest, 0, dest.length).

Parameters

dest	The destination byte array

Returns

This buffer

Throws

BufferUnderflowException	if `dest.length` is greater than `remaining()`

public abstract byte get (int index)

Returns a byte at the specified index, and the position is not changed.

Parameters

index	The index, must be no less than zero and less than limit

Returns

A byte at the specified index.

Throws

IndexOutOfBoundsException	If index is invalid

public abstract char getChar (int index)

Returns the char at the specified index.

The 2 bytes start from the specified index are composed into a char according to current byte order and returned. The position is not changed.

Parameters

index	The index, must be no less than zero and equal or less than `limit - 2`

Returns

The char at the specified index.

Throws

IndexOutOfBoundsException	If `index` is invalid

public abstract char getChar ()

Returns the char at the current position and increase the position by 2.

The 2 bytes start from the current position are composed into a char according to current byte order and returned. The position increases by 2.

Returns

The char at the current position.

Throws

BufferUnderflowException	If the position is greater than `limit - 2`

public abstract double getDouble ()

Returns the double at the current position and increase the position by 8.

The 8 bytes start from the current position are composed into a double according to current byte order and returned. The position increases by 8.

Returns

The double at the current position.

Throws

BufferUnderflowException	If the position is greater than `limit - 8`

public abstract double getDouble (int index)

Returns the double at the specified index.

The 8 bytes start from the specified index are composed into a double according to current byte order and returned. The position is not changed.

Parameters

index	The index, must be no less than zero and equal or less than `limit - 8`

Returns

The double at the specified index.

Throws

IndexOutOfBoundsException	If `index` is invalid

public abstract float getFloat ()

Returns the float at the current position and increase the position by 4.

The 4 bytes start from the current position are composed into a float according to current byte order and returned. The position increases by 4.

Returns

The float at the current position.

Throws

BufferUnderflowException	If the position is greater than `limit - 4`

public abstract float getFloat (int index)

Returns the float at the specified index.

The 4 bytes start from the specified index are composed into a float according to current byte order and returned. The position is not changed.

Parameters

index	The index, must be no less than zero and equal or less than `limit - 4`

Returns

The float at the specified index.

Throws

IndexOutOfBoundsException	If `index` is invalid

public abstract int getInt (int index)

Returns the int at the specified index.

The 4 bytes start from the specified index are composed into a int according to current byte order and returned. The position is not changed.

Parameters

index	The index, must be no less than zero and equal or less than `limit - 4`

Returns

The int at the specified index.

Throws

IndexOutOfBoundsException	If `index` is invalid

public abstract int getInt ()

Returns the int at the current position and increase the position by 4.

The 4 bytes start from the current position are composed into a int according to current byte order and returned. The position increases by 4.

Returns

The int at the current position.

Throws

BufferUnderflowException	If the position is greater than `limit - 4`

public abstract long getLong ()

Returns the long at the current position and increase the position by 8.

The 8 bytes start from the current position are composed into a long according to current byte order and returned. The position increases by 8.

Returns

The long at the current position.

Throws

BufferUnderflowException	If the position is greater than `limit - 8`

public abstract long getLong (int index)

Returns the long at the specified index.

The 8 bytes start from the specified index are composed into a long according to current byte order and returned. The position is not changed.

Parameters

index	The index, must be no less than zero and equal or less than `limit - 8`

Returns

The long at the specified index.

Throws

IndexOutOfBoundsException	If `index` is invalid

public abstract short getShort (int index)

Returns the short at the specified index.

The 2 bytes start from the specified index are composed into a short according to current byte order and returned. The position is not changed.

Parameters

index	The index, must be no less than zero and equal or less than `limit - 2`

Returns

The short at the specified index.

Throws

IndexOutOfBoundsException	If `index` is invalid

public abstract short getShort ()

Returns the short at the current position and increase the position by 2.

The 2 bytes start from the current position are composed into a short according to current byte order and returned. The position increases by 2.

Returns

The short at the current position.

Throws

BufferUnderflowException	If the position is greater than `limit - 2`

public final boolean hasArray ()

Returns whether this buffer is based on a byte array and is read/write.

If this buffer is readonly, then false is returned.

Returns

Whether this buffer is based on a byte array and is read/write.

public int hashCode ()

Hash code is calculated from the remaining bytes.

Position, limit, capacity and mark don't affect the hash code.

Returns

The hash code calculated from the remaining bytes.

public abstract boolean isDirect ()

Returns true if this buffer is direct.

A byte buffer is direct, if it is based on a byte buffer and the byte buffer is direct.

Returns

True if this buffer is direct.

public final ByteOrder order ()

Returns the byte order used by this buffer when converting bytes from/to other primitive types.

The default byte order of byte buffer is always BIG_ENDIAN.

Returns

The byte order used by this buffer when converting bytes from/to other primitive types.

public final ByteBuffer order (ByteOrder byteOrder)

Sets the byte order of this buffer.

Parameters

byteOrder	The byte order to set. If `null` then the order will be LITTLE_ENDIAN.

Returns

This buffer

public final ByteBuffer put (byte[] src)

Writes bytes in the given byte array to the current position and increase the position by the number of bytes written.

Calling this method has the same effect as put(src, 0, src.length).

Parameters

src	The source byte array

Returns

This buffer

Throws

BufferOverflowException	If `remaining()` is less than `src.length`
ReadOnlyBufferException	If no changes may be made to the contents of this buffer

public abstract ByteBuffer put (byte b)

Writes the given byte to the current position and increase the position by 1.

Parameters

b	The byte to write

Returns

This buffer

Throws

BufferOverflowException	If position is equal or greater than limit
ReadOnlyBufferException	If no changes may be made to the contents of this buffer

public abstract ByteBuffer put (int index, byte b)

Write a byte to the specified index of this buffer and the position is not changed.

Parameters

index	The index, must be no less than zero and less than the limit
b	The byte to write

Returns

This buffer

Throws

IndexOutOfBoundsException	If `index` is invalid
ReadOnlyBufferException	If no changes may be made to the contents of this buffer

public ByteBuffer put (ByteBuffer src)

Writes all the remaining bytes of the src byte buffer to this buffer's current position, and increase both buffers' position by the number of bytes copied.

Parameters

src	The source byte buffer

Returns

This buffer

Throws

BufferOverflowException	If `src.remaining()` is greater than this buffer's `remaining()`
IllegalArgumentException	If `src` is this buffer
ReadOnlyBufferException	If no changes may be made to the contents of this buffer

public ByteBuffer put (byte[] src, int off, int len)

Writes bytes in the given byte array, starting from the specified offset, to the current position and increase the position by the number of bytes written.

Parameters

src	The source byte array
off	The offset of byte array, must be no less than zero and no greater than `src.length`
len	The number of `byte`s to write, must be no less than zero and no greater than `src.length - off`

Returns

This buffer

Throws

BufferOverflowException	If `remaining()` is less than `len`
IndexOutOfBoundsException	If either `off` or `len` is invalid
ReadOnlyBufferException	If no changes may be made to the contents of this buffer

public abstract ByteBuffer putChar (int index, char value)

Write a char to the specified index of this buffer.

The char is converted to bytes using the current byte order. The position is not changed.

Parameters

index	The index, must be no less than zero and equal or less than `limit - 2`
value	The char to write

Returns

This buffer

Throws

IndexOutOfBoundsException	If `index` is invalid
ReadOnlyBufferException	If no changes may be made to the contents of this buffer

public abstract ByteBuffer putChar (char value)

Writes the given char to the current position and increase the position by 2.

The char is converted to bytes using the current byte order.

Parameters

value	The char to write

Returns

This buffer

Throws

BufferOverflowException	If position is greater than `limit - 2`
ReadOnlyBufferException	If no changes may be made to the contents of this buffer

public abstract ByteBuffer putDouble (int index, double value)

Write a double to the specified index of this buffer.

The double is converted to bytes using the current byte order. The position is not changed.

Parameters

index	The index, must be no less than zero and equal or less than `limit - 8`
value	The double to write

Returns

This buffer

Throws

IndexOutOfBoundsException	If `index` is invalid
ReadOnlyBufferException	If no changes may be made to the contents of this buffer

public abstract ByteBuffer putDouble (double value)

Writes the given double to the current position and increase the position by 8.

The double is converted to bytes using the current byte order.

Parameters

value	The double to write

Returns

This buffer

Throws

BufferOverflowException	If position is greater than `limit - 8`
ReadOnlyBufferException	If no changes may be made to the contents of this buffer

public abstract ByteBuffer putFloat (int index, float value)

Write a float to the specified index of this buffer.

The float is converted to bytes using the current byte order. The position is not changed.

Parameters

index	The index, must be no less than zero and equal or less than `limit - 4`
value	The float to write

Returns

This buffer

Throws

IndexOutOfBoundsException	If `index` is invalid
ReadOnlyBufferException	If no changes may be made to the contents of this buffer

public abstract ByteBuffer putFloat (float value)

Writes the given float to the current position and increase the position by 4.

The float is converted to bytes using the current byte order.

Parameters

value	The float to write

Returns

This buffer

Throws

BufferOverflowException	If position is greater than `limit - 4`
ReadOnlyBufferException	If no changes may be made to the contents of this buffer

public abstract ByteBuffer putInt (int value)

Writes the given int to the current position and increase the position by 4.

The int is converted to bytes using the current byte order.

Parameters

value	The int to write

Returns

This buffer

Throws

BufferOverflowException	If position is greater than `limit - 4`
ReadOnlyBufferException	If no changes may be made to the contents of this buffer

public abstract ByteBuffer putInt (int index, int value)

Write a int to the specified index of this buffer.

The int is converted to bytes using the current byte order. The position is not changed.

Parameters

index	The index, must be no less than zero and equal or less than `limit - 4`
value	The int to write

Returns

This buffer

Throws

IndexOutOfBoundsException	If `index` is invalid
ReadOnlyBufferException	If no changes may be made to the contents of this buffer

public abstract ByteBuffer putLong (long value)

Writes the given long to the current position and increase the position by 8.

The long is converted to bytes using the current byte order.

Parameters

value	The long to write

Returns

This buffer

Throws

BufferOverflowException	If position is greater than `limit - 8`
ReadOnlyBufferException	If no changes may be made to the contents of this buffer

public abstract ByteBuffer putLong (int index, long value)

Write a long to the specified index of this buffer.

The long is converted to bytes using the current byte order. The position is not changed.

Parameters

index	The index, must be no less than zero and equal or less than `limit - 8`
value	The long to write

Returns

This buffer

Throws

IndexOutOfBoundsException	If `index` is invalid
ReadOnlyBufferException	If no changes may be made to the contents of this buffer

public abstract ByteBuffer putShort (int index, short value)

Write a short to the specified index of this buffer.

The short is converted to bytes using the current byte order. The position is not changed.

Parameters

index	The index, must be no less than zero and equal or less than `limit - 2`
value	The short to write

Returns

This buffer

Throws

IndexOutOfBoundsException	If `index` is invalid
ReadOnlyBufferException	If no changes may be made to the contents of this buffer

public abstract ByteBuffer putShort (short value)

Writes the given short to the current position and increase the position by 2.

The short is converted to bytes using the current byte order.

Parameters

value	The short to write

Returns

This buffer

Throws

BufferOverflowException	If position is greater than `limit - 2`
ReadOnlyBufferException	If no changes may be made to the contents of this buffer

public abstract ByteBuffer slice ()

Returns a sliced buffer that shares content with this buffer.

The sliced buffer's capacity will be this buffer's remaining(), and its zero position will correspond to this buffer's current position. The new buffer's position will be 0, limit will be its capacity, and its mark is unset. The new buffer's readonly property and byte order are same as this buffer.

The new buffer shares content with this buffer, which means either buffer's change of content will be visible to the other. The two buffer's position, limit and mark are independent.

Returns

A sliced buffer that shares content with this buffer.

public String toString ()

Returns a string represents the state of this byte buffer.

Returns

A string represents the state of this byte buffer.

public static ByteBuffer wrap (byte[] array)

Creates a new byte buffer by wrapping the given byte array.

Calling this method has the same effect as wrap(array, 0, array.length).

Parameters

array	The byte array which the new buffer will be based on

Returns

The created byte buffer

public static ByteBuffer wrap (byte[] array, int start, int len)

Creates new a byte buffer by wrapping the given byte array.

The new buffer's position will be start, limit will be start + len, capacity will be the length of the array.

Parameters

array	The byte array which the new buffer will be based on
start	The start index, must be no less than zero and no greater than `array.length`
len	The length, must be no less than zero and no greater than `array.length - start`

Returns

The created byte buffer

Throws

IndexOutOfBoundsException	If either `start` or `len` is invalid

Jan	FEB	Mar
	27
2008	2009	2010

Classes

Exceptions

ByteBuffer

Class Overview

Summary

Public Methods

public static ByteBuffer allocate (int capacity)

Parameters

Returns

Throws

public static ByteBuffer allocateDirect (int capacity)

Parameters

Returns

Throws

public final byte[] array ()

Returns

Throws

public final int arrayOffset ()

Returns

Throws

public abstract CharBuffer asCharBuffer ()

Returns

public abstract DoubleBuffer asDoubleBuffer ()

Returns

public abstract FloatBuffer asFloatBuffer ()

Returns

public abstract IntBuffer asIntBuffer ()

Returns

public abstract LongBuffer asLongBuffer ()

Returns

public abstract ByteBuffer asReadOnlyBuffer ()

Returns

public abstract ShortBuffer asShortBuffer ()

Returns

public abstract ByteBuffer compact ()

Returns

Throws

public int compareTo (ByteBuffer otherBuffer)

Parameters

Returns

Throws

public abstract ByteBuffer duplicate ()

Returns

public boolean equals (Object other)

Parameters

Returns

public abstract byte get ()

Returns

Throws

public ByteBuffer get (byte[] dest, int off, int len)

Parameters

Returns

Throws

public ByteBuffer get (byte[] dest)

Parameters

Returns

Throws

public abstract byte get (int index)

Parameters

Returns

Throws

public abstract char getChar (int index)

Parameters

Returns

Throws

public abstract char getChar ()

Returns

Throws

public abstract double getDouble ()

Returns

Throws

public abstract double getDouble (int index)

Parameters

Returns

Throws

public abstract float getFloat ()

Returns

Throws

public abstract float getFloat (int index)

Parameters