java.nio
Class ByteBuffer

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.nio.Buffer sample code for java.nio.Buffer definition code for java.nio.Buffer 
      extended by java.nio.ByteBuffer
All Implemented Interfaces:
Comparable sample code for java.lang.Comparable definition code for java.lang.Comparable <ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer >
Direct Known Subclasses:
MappedByteBuffer sample code for java.nio.MappedByteBuffer definition code for java.nio.MappedByteBuffer

public abstract class ByteBuffer
extends Buffer sample code for java.nio.Buffer definition code for java.nio.Buffer
implements Comparable sample code for java.lang.Comparable definition code for java.lang.Comparable <ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer >

A byte buffer.

This class defines six categories of operations upon byte buffers:

Byte buffers can be created either by allocation sample code for java.nio.ByteBuffer.allocate(int) definition code for java.nio.ByteBuffer.allocate(int) , which allocates space for the buffer's content, or by wrapping sample code for java.nio.ByteBuffer.wrap(byte[]) definition code for java.nio.ByteBuffer.wrap(byte[]) an existing byte array into a buffer.

Direct vs. non-direct buffers

A byte buffer is either direct or non-direct. Given a direct byte buffer, the Java virtual machine will make a best effort to perform native I/O operations directly upon it. That is, it will attempt to avoid copying the buffer's content to (or from) an intermediate buffer before (or after) each invocation of one of the underlying operating system's native I/O operations.

A direct byte buffer may be created by invoking the allocateDirect sample code for java.nio.ByteBuffer.allocateDirect(int) definition code for java.nio.ByteBuffer.allocateDirect(int) factory method of this class. The buffers returned by this method typically have somewhat higher allocation and deallocation costs than non-direct buffers. The contents of direct buffers may reside outside of the normal garbage-collected heap, and so their impact upon the memory footprint of an application might not be obvious. It is therefore recommended that direct buffers be allocated primarily for large, long-lived buffers that are subject to the underlying system's native I/O operations. In general it is best to allocate direct buffers only when they yield a measureable gain in program performance.

A direct byte buffer may also be created by mapping sample code for java.nio.channels.FileChannel.map(java.nio.channels.FileChannel.MapMode, long, long) definition code for java.nio.channels.FileChannel.map(java.nio.channels.FileChannel.MapMode, long, long) a region of a file directly into memory. An implementation of the Java platform may optionally support the creation of direct byte buffers from native code via JNI. If an instance of one of these kinds of buffers refers to an inaccessible region of memory then an attempt to access that region will not change the buffer's content and will cause an unspecified exception to be thrown either at the time of the access or at some later time.

Whether a byte buffer is direct or non-direct may be determined by invoking its isDirect sample code for java.nio.ByteBuffer.isDirect() definition code for java.nio.ByteBuffer.isDirect() method. This method is provided so that explicit buffer management can be done in performance-critical code.

Access to binary data

This class defines methods for reading and writing values of all other primitive types, except boolean. Primitive values are translated to (or from) sequences of bytes according to the buffer's current byte order, which may be retrieved and modified via the order sample code for java.nio.ByteBuffer.order() definition code for java.nio.ByteBuffer.order() methods. Specific byte orders are represented by instances of the ByteOrder sample code for java.nio.ByteOrder definition code for java.nio.ByteOrder class. The initial order of a byte buffer is always BIG_ENDIAN sample code for java.nio.ByteOrder.BIG_ENDIAN definition code for java.nio.ByteOrder.BIG_ENDIAN .

For access to heterogeneous binary data, that is, sequences of values of different types, this class defines a family of absolute and relative get and put methods for each type. For 32-bit floating-point values, for example, this class defines:

 float  getFloat() sample code for java.nio.ByteBuffer.getFloat() definition code for java.nio.ByteBuffer.getFloat() 
 float  getFloat(int index) sample code for java.nio.ByteBuffer.getFloat(int) definition code for java.nio.ByteBuffer.getFloat(int) 
  void  putFloat(float f) sample code for java.nio.ByteBuffer.putFloat(float) definition code for java.nio.ByteBuffer.putFloat(float) 
  void  putFloat(int index, float f) sample code for java.nio.ByteBuffer.putFloat(int, float) definition code for java.nio.ByteBuffer.putFloat(int, float) 

Corresponding methods are defined for the types char, short, int, long, and double. The index parameters of the absolute get and put methods are in terms of bytes rather than of the type being read or written.

For access to homogeneous binary data, that is, sequences of values of the same type, this class defines methods that can create views of a given byte buffer. A view buffer is simply another buffer whose content is backed by the byte buffer. Changes to the byte buffer's content will be visible in the view buffer, and vice versa; the two buffers' position, limit, and mark values are independent. The asFloatBuffer sample code for java.nio.ByteBuffer.asFloatBuffer() definition code for java.nio.ByteBuffer.asFloatBuffer() method, for example, creates an instance of the FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer class that is backed by the byte buffer upon which the method is invoked. Corresponding view-creation methods are defined for the types char, short, int, long, and double.

View buffers have three important advantages over the families of type-specific get and put methods described above:

The byte order of a view buffer is fixed to be that of its byte buffer at the time that the view is created.

Invocation chaining

Methods in this class that do not otherwise have a value to return are specified to return the buffer upon which they are invoked. This allows method invocations to be chained. The sequence of statements

 bb.putInt(0xCAFEBABE);
 bb.putShort(3);
 bb.putShort(45);
can, for example, be replaced by the single statement
 bb.putInt(0xCAFEBABE).putShort(3).putShort(45);

Since:
1.4

Method Summary
static ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer allocate sample code for java.nio.ByteBuffer.allocate(int) definition code for java.nio.ByteBuffer.allocate(int) (int capacity)
          Allocates a new byte buffer.
static ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer allocateDirect sample code for java.nio.ByteBuffer.allocateDirect(int) definition code for java.nio.ByteBuffer.allocateDirect(int) (int capacity)
          Allocates a new direct byte buffer.
 byte[] array sample code for java.nio.ByteBuffer.array() definition code for java.nio.ByteBuffer.array() ()
          Returns the byte array that backs this buffer  (optional operation).
 int arrayOffset sample code for java.nio.ByteBuffer.arrayOffset() definition code for java.nio.ByteBuffer.arrayOffset() ()
          Returns the offset within this buffer's backing array of the first element of the buffer  (optional operation).
abstract  CharBuffer sample code for java.nio.CharBuffer definition code for java.nio.CharBuffer asCharBuffer sample code for java.nio.ByteBuffer.asCharBuffer() definition code for java.nio.ByteBuffer.asCharBuffer() ()
          Creates a view of this byte buffer as a char buffer.
abstract  DoubleBuffer sample code for java.nio.DoubleBuffer definition code for java.nio.DoubleBuffer asDoubleBuffer sample code for java.nio.ByteBuffer.asDoubleBuffer() definition code for java.nio.ByteBuffer.asDoubleBuffer() ()
          Creates a view of this byte buffer as a double buffer.
abstract  FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer asFloatBuffer sample code for java.nio.ByteBuffer.asFloatBuffer() definition code for java.nio.ByteBuffer.asFloatBuffer() ()
          Creates a view of this byte buffer as a float buffer.
abstract  IntBuffer sample code for java.nio.IntBuffer definition code for java.nio.IntBuffer asIntBuffer sample code for java.nio.ByteBuffer.asIntBuffer() definition code for java.nio.ByteBuffer.asIntBuffer() ()
          Creates a view of this byte buffer as an int buffer.
abstract  LongBuffer sample code for java.nio.LongBuffer definition code for java.nio.LongBuffer asLongBuffer sample code for java.nio.ByteBuffer.asLongBuffer() definition code for java.nio.ByteBuffer.asLongBuffer() ()
          Creates a view of this byte buffer as a long buffer.
abstract  ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer asReadOnlyBuffer sample code for java.nio.ByteBuffer.asReadOnlyBuffer() definition code for java.nio.ByteBuffer.asReadOnlyBuffer() ()
          Creates a new, read-only byte buffer that shares this buffer's content.
abstract  ShortBuffer sample code for java.nio.ShortBuffer definition code for java.nio.ShortBuffer asShortBuffer sample code for java.nio.ByteBuffer.asShortBuffer() definition code for java.nio.ByteBuffer.asShortBuffer() ()
          Creates a view of this byte buffer as a short buffer.
abstract  ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer compact sample code for java.nio.ByteBuffer.compact() definition code for java.nio.ByteBuffer.compact() ()
          Compacts this buffer  (optional operation).
 int compareTo sample code for java.nio.ByteBuffer.compareTo(java.nio.ByteBuffer) definition code for java.nio.ByteBuffer.compareTo(java.nio.ByteBuffer) (ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  that)
          Compares this buffer to another.
abstract  ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer duplicate sample code for java.nio.ByteBuffer.duplicate() definition code for java.nio.ByteBuffer.duplicate() ()
          Creates a new byte buffer that shares this buffer's content.
 boolean equals sample code for java.nio.ByteBuffer.equals(java.lang.Object) definition code for java.nio.ByteBuffer.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  ob)
          Tells whether or not this buffer is equal to another object.
abstract  byte get sample code for java.nio.ByteBuffer.get() definition code for java.nio.ByteBuffer.get() ()
          Relative get method.
 ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer get sample code for java.nio.ByteBuffer.get(byte[]) definition code for java.nio.ByteBuffer.get(byte[]) (byte[] dst)
          Relative bulk get method.
 ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer get sample code for java.nio.ByteBuffer.get(byte[], int, int) definition code for java.nio.ByteBuffer.get(byte[], int, int) (byte[] dst, int offset, int length)
          Relative bulk get method.
abstract  byte get sample code for java.nio.ByteBuffer.get(int) definition code for java.nio.ByteBuffer.get(int) (int index)
          Absolute get method.
abstract  char getChar sample code for java.nio.ByteBuffer.getChar() definition code for java.nio.ByteBuffer.getChar() ()
          Relative get method for reading a char value.
abstract  char getChar sample code for java.nio.ByteBuffer.getChar(int) definition code for java.nio.ByteBuffer.getChar(int) (int index)
          Absolute get method for reading a char value.
abstract  double getDouble sample code for java.nio.ByteBuffer.getDouble() definition code for java.nio.ByteBuffer.getDouble() ()
          Relative get method for reading a double value.
abstract  double getDouble sample code for java.nio.ByteBuffer.getDouble(int) definition code for java.nio.ByteBuffer.getDouble(int) (int index)
          Absolute get method for reading a double value.
abstract  float getFloat sample code for java.nio.ByteBuffer.getFloat() definition code for java.nio.ByteBuffer.getFloat() ()
          Relative get method for reading a float value.
abstract  float getFloat sample code for java.nio.ByteBuffer.getFloat(int) definition code for java.nio.ByteBuffer.getFloat(int) (int index)
          Absolute get method for reading a float value.
abstract  int getInt sample code for java.nio.ByteBuffer.getInt() definition code for java.nio.ByteBuffer.getInt() ()
          Relative get method for reading an int value.
abstract  int getInt sample code for java.nio.ByteBuffer.getInt(int) definition code for java.nio.ByteBuffer.getInt(int) (int index)
          Absolute get method for reading an int value.
abstract  long getLong sample code for java.nio.ByteBuffer.getLong() definition code for java.nio.ByteBuffer.getLong() ()
          Relative get method for reading a long value.
abstract  long getLong sample code for java.nio.ByteBuffer.getLong(int) definition code for java.nio.ByteBuffer.getLong(int) (int index)
          Absolute get method for reading a long value.
abstract  short getShort sample code for java.nio.ByteBuffer.getShort() definition code for java.nio.ByteBuffer.getShort() ()
          Relative get method for reading a short value.
abstract  short getShort sample code for java.nio.ByteBuffer.getShort(int) definition code for java.nio.ByteBuffer.getShort(int) (int index)
          Absolute get method for reading a short value.
 boolean hasArray sample code for java.nio.ByteBuffer.hasArray() definition code for java.nio.ByteBuffer.hasArray() ()
          Tells whether or not this buffer is backed by an accessible byte array.
 int hashCode sample code for java.nio.ByteBuffer.hashCode() definition code for java.nio.ByteBuffer.hashCode() ()
          Returns the current hash code of this buffer.
abstract  boolean isDirect sample code for java.nio.ByteBuffer.isDirect() definition code for java.nio.ByteBuffer.isDirect() ()
          Tells whether or not this byte buffer is direct.
 ByteOrder sample code for java.nio.ByteOrder definition code for java.nio.ByteOrder order sample code for java.nio.ByteBuffer.order() definition code for java.nio.ByteBuffer.order() ()
          Retrieves this buffer's byte order.
 ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer order sample code for java.nio.ByteBuffer.order(java.nio.ByteOrder) definition code for java.nio.ByteBuffer.order(java.nio.ByteOrder) (ByteOrder sample code for java.nio.ByteOrder definition code for java.nio.ByteOrder  bo)
          Modifies this buffer's byte order.
abstract  ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer put sample code for java.nio.ByteBuffer.put(byte) definition code for java.nio.ByteBuffer.put(byte) (byte b)
          Relative put method  (optional operation).
 ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer put sample code for java.nio.ByteBuffer.put(byte[]) definition code for java.nio.ByteBuffer.put(byte[]) (byte[] src)
          Relative bulk put method  (optional operation).
 ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer put sample code for java.nio.ByteBuffer.put(byte[], int, int) definition code for java.nio.ByteBuffer.put(byte[], int, int) (byte[] src, int offset, int length)
          Relative bulk put method  (optional operation).
 ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer put sample code for java.nio.ByteBuffer.put(java.nio.ByteBuffer) definition code for java.nio.ByteBuffer.put(java.nio.ByteBuffer) (ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  src)
          Relative bulk put method  (optional operation).
abstract  ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer put sample code for java.nio.ByteBuffer.put(int, byte) definition code for java.nio.ByteBuffer.put(int, byte) (int index, byte b)
          Absolute put method  (optional operation).
abstract  ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer putChar sample code for java.nio.ByteBuffer.putChar(char) definition code for java.nio.ByteBuffer.putChar(char) (char value)
          Relative put method for writing a char value  (optional operation).
abstract  ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer putChar sample code for java.nio.ByteBuffer.putChar(int, char) definition code for java.nio.ByteBuffer.putChar(int, char) (int index, char value)
          Absolute put method for writing a char value  (optional operation).
abstract  ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer putDouble sample code for java.nio.ByteBuffer.putDouble(double) definition code for java.nio.ByteBuffer.putDouble(double) (double value)
          Relative put method for writing a double value  (optional operation).
abstract  ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer putDouble sample code for java.nio.ByteBuffer.putDouble(int, double) definition code for java.nio.ByteBuffer.putDouble(int, double) (int index, double value)
          Absolute put method for writing a double value  (optional operation).
abstract  ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer putFloat sample code for java.nio.ByteBuffer.putFloat(float) definition code for java.nio.ByteBuffer.putFloat(float) (float value)
          Relative put method for writing a float value  (optional operation).
abstract  ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer putFloat sample code for java.nio.ByteBuffer.putFloat(int, float) definition code for java.nio.ByteBuffer.putFloat(int, float) (int index, float value)
          Absolute put method for writing a float value  (optional operation).
abstract  ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer putInt sample code for java.nio.ByteBuffer.putInt(int) definition code for java.nio.ByteBuffer.putInt(int) (int value)
          Relative put method for writing an int value  (optional operation).
abstract  ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer putInt sample code for java.nio.ByteBuffer.putInt(int, int) definition code for java.nio.ByteBuffer.putInt(int, int) (int index, int value)
          Absolute put method for writing an int value  (optional operation).
abstract  ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer putLong sample code for java.nio.ByteBuffer.putLong(int, long) definition code for java.nio.ByteBuffer.putLong(int, long) (int index, long value)
          Absolute put method for writing a long value  (optional operation).
abstract  ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer putLong sample code for java.nio.ByteBuffer.putLong(long) definition code for java.nio.ByteBuffer.putLong(long) (long value)
          Relative put method for writing a long value  (optional operation).
abstract  ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer putShort sample code for java.nio.ByteBuffer.putShort(int, short) definition code for java.nio.ByteBuffer.putShort(int, short) (int index, short value)
          Absolute put method for writing a short value  (optional operation).
abstract  ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer putShort sample code for java.nio.ByteBuffer.putShort(short) definition code for java.nio.ByteBuffer.putShort(short) (short value)
          Relative put method for writing a short value  (optional operation).
abstract  ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer slice sample code for java.nio.ByteBuffer.slice() definition code for java.nio.ByteBuffer.slice() ()
          Creates a new byte buffer whose content is a shared subsequence of this buffer's content.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for java.nio.ByteBuffer.toString() definition code for java.nio.ByteBuffer.toString() ()
          Returns a string summarizing the state of this buffer.
static ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer wrap sample code for java.nio.ByteBuffer.wrap(byte[]) definition code for java.nio.ByteBuffer.wrap(byte[]) (byte[] array)
          Wraps a byte array into a buffer.
static ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer wrap sample code for java.nio.ByteBuffer.wrap(byte[], int, int) definition code for java.nio.ByteBuffer.wrap(byte[], int, int) (byte[] array, int offset, int length)
          Wraps a byte array into a buffer.
 
Methods inherited from class java.nio.Buffer sample code for java.nio.Buffer definition code for java.nio.Buffer
capacity sample code for java.nio.Buffer.capacity() definition code for java.nio.Buffer.capacity() , clear sample code for java.nio.Buffer.clear() definition code for java.nio.Buffer.clear() , flip sample code for java.nio.Buffer.flip() definition code for java.nio.Buffer.flip() , hasRemaining sample code for java.nio.Buffer.hasRemaining() definition code for java.nio.Buffer.hasRemaining() , isReadOnly sample code for java.nio.Buffer.isReadOnly() definition code for java.nio.Buffer.isReadOnly() , limit sample code for java.nio.Buffer.limit() definition code for java.nio.Buffer.limit() , limit sample code for java.nio.Buffer.limit(int) definition code for java.nio.Buffer.limit(int) , mark sample code for java.nio.Buffer.mark() definition code for java.nio.Buffer.mark() , position sample code for java.nio.Buffer.position() definition code for java.nio.Buffer.position() , position sample code for java.nio.Buffer.position(int) definition code for java.nio.Buffer.position(int) , remaining sample code for java.nio.Buffer.remaining() definition code for java.nio.Buffer.remaining() , reset sample code for java.nio.Buffer.reset() definition code for java.nio.Buffer.reset() , rewind sample code for java.nio.Buffer.rewind() definition code for java.nio.Buffer.rewind()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Method Detail

allocateDirect sample code for java.nio.ByteBuffer.allocateDirect(int) definition code for java.nio.ByteBuffer.allocateDirect(int)

public static ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  allocateDirect(int capacity)
Allocates a new direct byte buffer.

The new buffer's position will be zero, its limit will be its capacity, and its mark will be undefined. Whether or not it has a backing array sample code for java.nio.ByteBuffer.hasArray() definition code for java.nio.ByteBuffer.hasArray() is unspecified.

Parameters:
capacity - The new buffer's capacity, in bytes
Returns:
The new byte buffer
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - If the capacity is a negative integer

allocate sample code for java.nio.ByteBuffer.allocate(int) definition code for java.nio.ByteBuffer.allocate(int)

public static ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  allocate(int capacity)
Allocates a new byte buffer.

The new buffer's position will be zero, its limit will be its capacity, and its mark will be undefined. It will have a backing array sample code for java.nio.ByteBuffer.array() definition code for java.nio.ByteBuffer.array() , and its array offset sample code for java.nio.ByteBuffer.arrayOffset() definition code for java.nio.ByteBuffer.arrayOffset() will be zero.

Parameters:
capacity - The new buffer's capacity, in bytes
Returns:
The new byte buffer
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - If the capacity is a negative integer

wrap sample code for java.nio.ByteBuffer.wrap(byte[], int, int) definition code for java.nio.ByteBuffer.wrap(byte[], int, int)

public static ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  wrap(byte[] array,
                              int offset,
                              int length)
Wraps a byte array into a buffer.

The new buffer will be backed by the given byte array; that is, modifications to the buffer will cause the array to be modified and vice versa. The new buffer's capacity will be array.length, its position will be offset, its limit will be offset + length, and its mark will be undefined. Its backing array sample code for java.nio.ByteBuffer.array() definition code for java.nio.ByteBuffer.array() will be the given array, and its array offset sample code for java.nio.ByteBuffer.arrayOffset() definition code for java.nio.ByteBuffer.arrayOffset() will be zero.

Parameters:
array - The array that will back the new buffer
offset - The offset of the subarray to be used; must be non-negative and no larger than array.length. The new buffer's position will be set to this value.
length - The length of the subarray to be used; must be non-negative and no larger than array.length - offset. The new buffer's limit will be set to offset + length.
Returns:
The new byte buffer
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If the preconditions on the offset and length parameters do not hold

wrap sample code for java.nio.ByteBuffer.wrap(byte[]) definition code for java.nio.ByteBuffer.wrap(byte[])

public static ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  wrap(byte[] array)
Wraps a byte array into a buffer.

The new buffer will be backed by the given byte array; that is, modifications to the buffer will cause the array to be modified and vice versa. The new buffer's capacity and limit will be array.length, its position will be zero, and its mark will be undefined. Its backing array sample code for java.nio.ByteBuffer.array() definition code for java.nio.ByteBuffer.array() will be the given array, and its array offset sample code for java.nio.ByteBuffer.arrayOffset() definition code for java.nio.ByteBuffer.arrayOffset() will be zero.

Parameters:
array - The array that will back this buffer
Returns:
The new byte buffer

slice sample code for java.nio.ByteBuffer.slice() definition code for java.nio.ByteBuffer.slice()

public abstract ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  slice()
Creates a new byte buffer whose content is a shared subsequence of this buffer's content.

The content of the new buffer will start at this buffer's current position. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer, and its mark will be undefined. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

Returns:
The new byte buffer

duplicate sample code for java.nio.ByteBuffer.duplicate() definition code for java.nio.ByteBuffer.duplicate()

public abstract ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  duplicate()
Creates a new byte buffer that shares this buffer's content.

The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

The new buffer's capacity, limit, position, and mark values will be identical to those of this buffer. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

Returns:
The new byte buffer

asReadOnlyBuffer sample code for java.nio.ByteBuffer.asReadOnlyBuffer() definition code for java.nio.ByteBuffer.asReadOnlyBuffer()

public abstract ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  asReadOnlyBuffer()
Creates a new, read-only byte buffer that shares this buffer's content.

The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer; the new buffer itself, however, will be read-only and will not allow the shared content to be modified. The two buffers' position, limit, and mark values will be independent.

The new buffer's capacity, limit, position, and mark values will be identical to those of this buffer.

If this buffer is itself read-only then this method behaves in exactly the same way as the duplicate sample code for java.nio.ByteBuffer.duplicate() definition code for java.nio.ByteBuffer.duplicate() method.

Returns:
The new, read-only byte buffer

get sample code for java.nio.ByteBuffer.get() definition code for java.nio.ByteBuffer.get()

public abstract byte get()
Relative get method. Reads the byte at this buffer's current position, and then increments the position.

Returns:
The byte at the buffer's current position
Throws:
BufferUnderflowException sample code for java.nio.BufferUnderflowException definition code for java.nio.BufferUnderflowException - If the buffer's current position is not smaller than its limit

put sample code for java.nio.ByteBuffer.put(byte) definition code for java.nio.ByteBuffer.put(byte)

public abstract ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  put(byte b)
Relative put method  (optional operation).

Writes the given byte into this buffer at the current position, and then increments the position.

Parameters:
b - The byte to be written
Returns:
This buffer
Throws:
BufferOverflowException sample code for java.nio.BufferOverflowException definition code for java.nio.BufferOverflowException - If this buffer's current position is not smaller than its limit
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

get sample code for java.nio.ByteBuffer.get(int) definition code for java.nio.ByteBuffer.get(int)

public abstract byte get(int index)
Absolute get method. Reads the byte at the given index.

Parameters:
index - The index from which the byte will be read
Returns:
The byte at the given index
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit

put sample code for java.nio.ByteBuffer.put(int, byte) definition code for java.nio.ByteBuffer.put(int, byte)

public abstract ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  put(int index,
                               byte b)
Absolute put method  (optional operation).

Writes the given byte into this buffer at the given index.

Parameters:
index - The index at which the byte will be written
b - The byte value to be written
Returns:
This buffer
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

get sample code for java.nio.ByteBuffer.get(byte[], int, int) definition code for java.nio.ByteBuffer.get(byte[], int, int)

public ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  get(byte[] dst,
                      int offset,
                      int length)
Relative bulk get method.

This method transfers bytes from this buffer into the given destination array. If there are fewer bytes remaining in the buffer than are required to satisfy the request, that is, if length > remaining(), then no bytes are transferred and a BufferUnderflowException sample code for java.nio.BufferUnderflowException definition code for java.nio.BufferUnderflowException is thrown.

Otherwise, this method copies length bytes from this buffer into the given array, starting at the current position of this buffer and at the given offset in the array. The position of this buffer is then incremented by length.

In other words, an invocation of this method of the form src.get(dst, off, len) has exactly the same effect as the loop

     for (int i = off; i < off + len; i++)
         dst[i] = src.get(); 
except that it first checks that there are sufficient bytes in this buffer and it is potentially much more efficient.

Parameters:
dst - The array into which bytes are to be written
offset - The offset within the array of the first byte to be written; must be non-negative and no larger than dst.length
length - The maximum number of bytes to be written to the given array; must be non-negative and no larger than dst.length - offset
Returns:
This buffer
Throws:
BufferUnderflowException sample code for java.nio.BufferUnderflowException definition code for java.nio.BufferUnderflowException - If there are fewer than length bytes remaining in this buffer
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If the preconditions on the offset and length parameters do not hold

get sample code for java.nio.ByteBuffer.get(byte[]) definition code for java.nio.ByteBuffer.get(byte[])

public ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  get(byte[] dst)
Relative bulk get method.

This method transfers bytes from this buffer into the given destination array. An invocation of this method of the form src.get(a) behaves in exactly the same way as the invocation

     src.get(a, 0, a.length) 

Returns:
This buffer
Throws:
BufferUnderflowException sample code for java.nio.BufferUnderflowException definition code for java.nio.BufferUnderflowException - If there are fewer than length bytes remaining in this buffer

put sample code for java.nio.ByteBuffer.put(java.nio.ByteBuffer) definition code for java.nio.ByteBuffer.put(java.nio.ByteBuffer)

public ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  put(ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  src)
Relative bulk put method  (optional operation).

This method transfers the bytes remaining in the given source buffer into this buffer. If there are more bytes remaining in the source buffer than in this buffer, that is, if src.remaining() > remaining(), then no bytes are transferred and a BufferOverflowException sample code for java.nio.BufferOverflowException definition code for java.nio.BufferOverflowException is thrown.

Otherwise, this method copies n = src.remaining() bytes from the given buffer into this buffer, starting at each buffer's current position. The positions of both buffers are then incremented by n.

In other words, an invocation of this method of the form dst.put(src) has exactly the same effect as the loop

     while (src.hasRemaining())
         dst.put(src.get()); 
except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.

Parameters:
src - The source buffer from which bytes are to be read; must not be this buffer
Returns:
This buffer
Throws:
BufferOverflowException sample code for java.nio.BufferOverflowException definition code for java.nio.BufferOverflowException - If there is insufficient space in this buffer for the remaining bytes in the source buffer
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - If the source buffer is this buffer
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

put sample code for java.nio.ByteBuffer.put(byte[], int, int) definition code for java.nio.ByteBuffer.put(byte[], int, int)

public ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  put(byte[] src,
                      int offset,
                      int length)
Relative bulk put method  (optional operation).

This method transfers bytes into this buffer from the given source array. If there are more bytes to be copied from the array than remain in this buffer, that is, if length > remaining(), then no bytes are transferred and a BufferOverflowException sample code for java.nio.BufferOverflowException definition code for java.nio.BufferOverflowException is thrown.

Otherwise, this method copies length bytes from the given array into this buffer, starting at the given offset in the array and at the current position of this buffer. The position of this buffer is then incremented by length.

In other words, an invocation of this method of the form dst.put(src, off, len) has exactly the same effect as the loop

     for (int i = off; i < off + len; i++)
         dst.put(a[i]); 
except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.

Parameters:
src - The array from which bytes are to be read
offset - The offset within the array of the first byte to be read; must be non-negative and no larger than array.length
length - The number of bytes to be read from the given array; must be non-negative and no larger than array.length - offset
Returns:
This buffer
Throws:
BufferOverflowException sample code for java.nio.BufferOverflowException definition code for java.nio.BufferOverflowException - If there is insufficient space in this buffer
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If the preconditions on the offset and length parameters do not hold
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

put sample code for java.nio.ByteBuffer.put(byte[]) definition code for java.nio.ByteBuffer.put(byte[])

public final ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  put(byte[] src)
Relative bulk put method  (optional operation).

This method transfers the entire content of the given source byte array into this buffer. An invocation of this method of the form dst.put(a) behaves in exactly the same way as the invocation

     dst.put(a, 0, a.length) 

Returns:
This buffer
Throws:
BufferOverflowException sample code for java.nio.BufferOverflowException definition code for java.nio.BufferOverflowException - If there is insufficient space in this buffer
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

hasArray sample code for java.nio.ByteBuffer.hasArray() definition code for java.nio.ByteBuffer.hasArray()

public final boolean hasArray()
Tells whether or not this buffer is backed by an accessible byte array.

If this method returns true then the array sample code for java.nio.ByteBuffer.array() definition code for java.nio.ByteBuffer.array() and arrayOffset sample code for java.nio.ByteBuffer.arrayOffset() definition code for java.nio.ByteBuffer.arrayOffset() methods may safely be invoked.

Returns:
true if, and only if, this buffer is backed by an array and is not read-only

array sample code for java.nio.ByteBuffer.array() definition code for java.nio.ByteBuffer.array()

public final byte[] array()
Returns the byte array that backs this buffer  (optional operation).

Modifications to this buffer's content will cause the returned array's content to be modified, and vice versa.

Invoke the hasArray sample code for java.nio.ByteBuffer.hasArray() definition code for java.nio.ByteBuffer.hasArray() method before invoking this method in order to ensure that this buffer has an accessible backing array.

Returns:
The array that backs this buffer
Throws:
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is backed by an array but is read-only
UnsupportedOperationException sample code for java.lang.UnsupportedOperationException definition code for java.lang.UnsupportedOperationException - If this buffer is not backed by an accessible array

arrayOffset sample code for java.nio.ByteBuffer.arrayOffset() definition code for java.nio.ByteBuffer.arrayOffset()

public final int arrayOffset()
Returns the offset within this buffer's backing array of the first element of the buffer  (optional operation).

If this buffer is backed by an array then buffer position p corresponds to array index p + arrayOffset().

Invoke the hasArray sample code for java.nio.ByteBuffer.hasArray() definition code for java.nio.ByteBuffer.hasArray() method before invoking this method in order to ensure that this buffer has an accessible backing array.

Returns:
The offset within this buffer's array of the first element of the buffer
Throws:
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is backed by an array but is read-only
UnsupportedOperationException sample code for java.lang.UnsupportedOperationException definition code for java.lang.UnsupportedOperationException - If this buffer is not backed by an accessible array

compact sample code for java.nio.ByteBuffer.compact() definition code for java.nio.ByteBuffer.compact()

public abstract ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  compact()
Compacts this buffer  (optional operation).

The bytes between the buffer's current position and its limit, if any, are copied to the beginning of the buffer. That is, the byte at index p = position() is copied to index zero, the byte at index p + 1 is copied to index one, and so forth until the byte at index limit() - 1 is copied to index n = limit() - 1 - p. The buffer's position is then set to n+1 and its limit is set to its capacity. The mark, if defined, is discarded.

The buffer's position is set to the number of bytes copied, rather than to zero, so that an invocation of this method can be followed immediately by an invocation of another relative put method.

Invoke this method after writing data from a buffer in case the write was incomplete. The following loop, for example, copies bytes from one channel to another via the buffer buf:

 buf.clear();          // Prepare buffer for use
 for (;;) {
     if (in.read(buf) < 0 && !buf.hasRemaining())
         break;        // No more bytes to transfer
     buf.flip();
     out.write(buf);
     buf.compact();    // In case of partial write
 }

Returns:
This buffer
Throws:
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

isDirect sample code for java.nio.ByteBuffer.isDirect() definition code for java.nio.ByteBuffer.isDirect()

public abstract boolean isDirect()
Tells whether or not this byte buffer is direct.

Returns:
true if, and only if, this buffer is direct

toString sample code for java.nio.ByteBuffer.toString() definition code for java.nio.ByteBuffer.toString()

public String sample code for java.lang.String definition code for java.lang.String  toString()
Returns a string summarizing the state of this buffer.

Overrides:
toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
A summary string

hashCode sample code for java.nio.ByteBuffer.hashCode() definition code for java.nio.ByteBuffer.hashCode()

public int hashCode()
Returns the current hash code of this buffer.

The hash code of a byte buffer depends only upon its remaining elements; that is, upon the elements from position() up to, and including, the element at limit() - 1.

Because buffer hash codes are content-dependent, it is inadvisable to use buffers as keys in hash maps or similar data structures unless it is known that their contents will not change.

Overrides:
hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
The current hash code of this buffer
See Also:
Object.equals(java.lang.Object) sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

equals sample code for java.nio.ByteBuffer.equals(java.lang.Object) definition code for java.nio.ByteBuffer.equals(java.lang.Object)

public boolean equals(Object sample code for java.lang.Object definition code for java.lang.Object  ob)
Tells whether or not this buffer is equal to another object.

Two byte buffers are equal if, and only if,

  1. They have the same element type,

  2. They have the same number of remaining elements, and

  3. The two sequences of remaining elements, considered independently of their starting positions, are pointwise equal.

A byte buffer is not equal to any other type of object.

Overrides:
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) in class Object sample code for java.lang.Object definition code for java.lang.Object
Parameters:
ob - The object to which this buffer is to be compared
Returns:
true if, and only if, this buffer is equal to the given object
See Also:
Object.hashCode() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

compareTo sample code for java.nio.ByteBuffer.compareTo(java.nio.ByteBuffer) definition code for java.nio.ByteBuffer.compareTo(java.nio.ByteBuffer)

public int compareTo(ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  that)
Compares this buffer to another.

Two byte buffers are compared by comparing their sequences of remaining elements lexicographically, without regard to the starting position of each sequence within its corresponding buffer.

A byte buffer is not comparable to any other type of object.

Specified by:
compareTo sample code for java.lang.Comparable.compareTo(T) definition code for java.lang.Comparable.compareTo(T) in interface Comparable sample code for java.lang.Comparable definition code for java.lang.Comparable <ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer >
Parameters:
that - the Object to be compared.
Returns:
A negative integer, zero, or a positive integer as this buffer is less than, equal to, or greater than the given buffer

order sample code for java.nio.ByteBuffer.order() definition code for java.nio.ByteBuffer.order()

public final ByteOrder sample code for java.nio.ByteOrder definition code for java.nio.ByteOrder  order()
Retrieves this buffer's byte order.

The byte order is used when reading or writing multibyte values, and when creating buffers that are views of this byte buffer. The order of a newly-created byte buffer is always BIG_ENDIAN sample code for java.nio.ByteOrder.BIG_ENDIAN definition code for java.nio.ByteOrder.BIG_ENDIAN .

Returns:
This buffer's byte order

order sample code for java.nio.ByteBuffer.order(java.nio.ByteOrder) definition code for java.nio.ByteBuffer.order(java.nio.ByteOrder)

public final ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  order(ByteOrder sample code for java.nio.ByteOrder definition code for java.nio.ByteOrder  bo)
Modifies this buffer's byte order.

Parameters:
bo - The new byte order, either BIG_ENDIAN sample code for java.nio.ByteOrder.BIG_ENDIAN definition code for java.nio.ByteOrder.BIG_ENDIAN or LITTLE_ENDIAN sample code for java.nio.ByteOrder.LITTLE_ENDIAN definition code for java.nio.ByteOrder.LITTLE_ENDIAN
Returns:
This buffer

getChar sample code for java.nio.ByteBuffer.getChar() definition code for java.nio.ByteBuffer.getChar()

public abstract char getChar()
Relative get method for reading a char value.

Reads the next two bytes at this buffer's current position, composing them into a char value according to the current byte order, and then increments the position by two.

Returns:
The char value at the buffer's current position
Throws:
BufferUnderflowException sample code for java.nio.BufferUnderflowException definition code for java.nio.BufferUnderflowException - If there are fewer than two bytes remaining in this buffer

putChar sample code for java.nio.ByteBuffer.putChar(char) definition code for java.nio.ByteBuffer.putChar(char)

public abstract ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  putChar(char value)
Relative put method for writing a char value  (optional operation).

Writes two bytes containing the given char value, in the current byte order, into this buffer at the current position, and then increments the position by two.

Parameters:
value - The char value to be written
Returns:
This buffer
Throws:
BufferOverflowException sample code for java.nio.BufferOverflowException definition code for java.nio.BufferOverflowException - If there are fewer than two bytes remaining in this buffer
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

getChar sample code for java.nio.ByteBuffer.getChar(int) definition code for java.nio.ByteBuffer.getChar(int)

public abstract char getChar(int index)
Absolute get method for reading a char value.

Reads two bytes at the given index, composing them into a char value according to the current byte order.

Parameters:
index - The index from which the bytes will be read
Returns:
The char value at the given index
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit, minus one

putChar sample code for java.nio.ByteBuffer.putChar(int, char) definition code for java.nio.ByteBuffer.putChar(int, char)

public abstract ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  putChar(int index,
                                   char value)
Absolute put method for writing a char value  (optional operation).

Writes two bytes containing the given char value, in the current byte order, into this buffer at the given index.

Parameters:
index - The index at which the bytes will be written
value - The char value to be written
Returns:
This buffer
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit, minus one
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

asCharBuffer sample code for java.nio.ByteBuffer.asCharBuffer() definition code for java.nio.ByteBuffer.asCharBuffer()

public abstract CharBuffer sample code for java.nio.CharBuffer definition code for java.nio.CharBuffer  asCharBuffer()
Creates a view of this byte buffer as a char buffer.

The content of the new buffer will start at this buffer's current position. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by two, and its mark will be undefined. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

Returns:
A new char buffer

getShort sample code for java.nio.ByteBuffer.getShort() definition code for java.nio.ByteBuffer.getShort()

public abstract short getShort()
Relative get method for reading a short value.

Reads the next two bytes at this buffer's current position, composing them into a short value according to the current byte order, and then increments the position by two.

Returns:
The short value at the buffer's current position
Throws:
BufferUnderflowException sample code for java.nio.BufferUnderflowException definition code for java.nio.BufferUnderflowException - If there are fewer than two bytes remaining in this buffer

putShort sample code for java.nio.ByteBuffer.putShort(short) definition code for java.nio.ByteBuffer.putShort(short)

public abstract ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  putShort(short value)
Relative put method for writing a short value  (optional operation).

Writes two bytes containing the given short value, in the current byte order, into this buffer at the current position, and then increments the position by two.

Parameters:
value - The short value to be written
Returns:
This buffer
Throws:
BufferOverflowException sample code for java.nio.BufferOverflowException definition code for java.nio.BufferOverflowException - If there are fewer than two bytes remaining in this buffer
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

getShort sample code for java.nio.ByteBuffer.getShort(int) definition code for java.nio.ByteBuffer.getShort(int)

public abstract short getShort(int index)
Absolute get method for reading a short value.

Reads two bytes at the given index, composing them into a short value according to the current byte order.

Parameters:
index - The index from which the bytes will be read
Returns:
The short value at the given index
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit, minus one

putShort sample code for java.nio.ByteBuffer.putShort(int, short) definition code for java.nio.ByteBuffer.putShort(int, short)

public abstract ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  putShort(int index,
                                    short value)
Absolute put method for writing a short value  (optional operation).

Writes two bytes containing the given short value, in the current byte order, into this buffer at the given index.

Parameters:
index - The index at which the bytes will be written
value - The short value to be written
Returns:
This buffer
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit, minus one
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

asShortBuffer sample code for java.nio.ByteBuffer.asShortBuffer() definition code for java.nio.ByteBuffer.asShortBuffer()

public abstract ShortBuffer sample code for java.nio.ShortBuffer definition code for java.nio.ShortBuffer  asShortBuffer()
Creates a view of this byte buffer as a short buffer.

The content of the new buffer will start at this buffer's current position. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by two, and its mark will be undefined. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

Returns:
A new short buffer

getInt sample code for java.nio.ByteBuffer.getInt() definition code for java.nio.ByteBuffer.getInt()

public abstract int getInt()
Relative get method for reading an int value.

Reads the next four bytes at this buffer's current position, composing them into an int value according to the current byte order, and then increments the position by four.

Returns:
The int value at the buffer's current position
Throws:
BufferUnderflowException sample code for java.nio.BufferUnderflowException definition code for java.nio.BufferUnderflowException - If there are fewer than four bytes remaining in this buffer

putInt sample code for java.nio.ByteBuffer.putInt(int) definition code for java.nio.ByteBuffer.putInt(int)

public abstract ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  putInt(int value)
Relative put method for writing an int value  (optional operation).

Writes four bytes containing the given int value, in the current byte order, into this buffer at the current position, and then increments the position by four.

Parameters:
value - The int value to be written
Returns:
This buffer
Throws:
BufferOverflowException sample code for java.nio.BufferOverflowException definition code for java.nio.BufferOverflowException - If there are fewer than four bytes remaining in this buffer
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

getInt sample code for java.nio.ByteBuffer.getInt(int) definition code for java.nio.ByteBuffer.getInt(int)

public abstract int getInt(int index)
Absolute get method for reading an int value.

Reads four bytes at the given index, composing them into a int value according to the current byte order.

Parameters:
index - The index from which the bytes will be read
Returns:
The int value at the given index
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit, minus three

putInt sample code for java.nio.ByteBuffer.putInt(int, int) definition code for java.nio.ByteBuffer.putInt(int, int)

public abstract ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  putInt(int index,
                                  int value)
Absolute put method for writing an int value  (optional operation).

Writes four bytes containing the given int value, in the current byte order, into this buffer at the given index.

Parameters:
index - The index at which the bytes will be written
value - The int value to be written
Returns:
This buffer
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit, minus three
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

asIntBuffer sample code for java.nio.ByteBuffer.asIntBuffer() definition code for java.nio.ByteBuffer.asIntBuffer()

public abstract IntBuffer sample code for java.nio.IntBuffer definition code for java.nio.IntBuffer  asIntBuffer()
Creates a view of this byte buffer as an int buffer.

The content of the new buffer will start at this buffer's current position. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by four, and its mark will be undefined. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

Returns:
A new int buffer

getLong sample code for java.nio.ByteBuffer.getLong() definition code for java.nio.ByteBuffer.getLong()

public abstract long getLong()
Relative get method for reading a long value.

Reads the next eight bytes at this buffer's current position, composing them into a long value according to the current byte order, and then increments the position by eight.

Returns:
The long value at the buffer's current position
Throws:
BufferUnderflowException sample code for java.nio.BufferUnderflowException definition code for java.nio.BufferUnderflowException - If there are fewer than eight bytes remaining in this buffer

putLong sample code for java.nio.ByteBuffer.putLong(long) definition code for java.nio.ByteBuffer.putLong(long)

public abstract ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  putLong(long value)
Relative put method for writing a long value  (optional operation).

Writes eight bytes containing the given long value, in the current byte order, into this buffer at the current position, and then increments the position by eight.

Parameters:
value - The long value to be written
Returns:
This buffer
Throws:
BufferOverflowException sample code for java.nio.BufferOverflowException definition code for java.nio.BufferOverflowException - If there are fewer than eight bytes remaining in this buffer
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

getLong sample code for java.nio.ByteBuffer.getLong(int) definition code for java.nio.ByteBuffer.getLong(int)

public abstract long getLong(int index)
Absolute get method for reading a long value.

Reads eight bytes at the given index, composing them into a long value according to the current byte order.

Parameters:
index - The index from which the bytes will be read
Returns:
The long value at the given index
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit, minus seven

putLong sample code for java.nio.ByteBuffer.putLong(int, long) definition code for java.nio.ByteBuffer.putLong(int, long)

public abstract ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  putLong(int index,
                                   long value)
Absolute put method for writing a long value  (optional operation).

Writes eight bytes containing the given long value, in the current byte order, into this buffer at the given index.

Parameters:
index - The index at which the bytes will be written
value - The long value to be written
Returns:
This buffer
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit, minus seven
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

asLongBuffer sample code for java.nio.ByteBuffer.asLongBuffer() definition code for java.nio.ByteBuffer.asLongBuffer()

public abstract LongBuffer sample code for java.nio.LongBuffer definition code for java.nio.LongBuffer  asLongBuffer()
Creates a view of this byte buffer as a long buffer.

The content of the new buffer will start at this buffer's current position. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by eight, and its mark will be undefined. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

Returns:
A new long buffer

getFloat sample code for java.nio.ByteBuffer.getFloat() definition code for java.nio.ByteBuffer.getFloat()

public abstract float getFloat()
Relative get method for reading a float value.

Reads the next four bytes at this buffer's current position, composing them into a float value according to the current byte order, and then increments the position by four.

Returns:
The float value at the buffer's current position
Throws:
BufferUnderflowException sample code for java.nio.BufferUnderflowException definition code for java.nio.BufferUnderflowException - If there are fewer than four bytes remaining in this buffer

putFloat sample code for java.nio.ByteBuffer.putFloat(float) definition code for java.nio.ByteBuffer.putFloat(float)

public abstract ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  putFloat(float value)
Relative put method for writing a float value  (optional operation).

Writes four bytes containing the given float value, in the current byte order, into this buffer at the current position, and then increments the position by four.

Parameters:
value - The float value to be written
Returns:
This buffer
Throws:
BufferOverflowException sample code for java.nio.BufferOverflowException definition code for java.nio.BufferOverflowException - If there are fewer than four bytes remaining in this buffer
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

getFloat sample code for java.nio.ByteBuffer.getFloat(int) definition code for java.nio.ByteBuffer.getFloat(int)

public abstract float getFloat(int index)
Absolute get method for reading a float value.

Reads four bytes at the given index, composing them into a float value according to the current byte order.

Parameters:
index - The index from which the bytes will be read
Returns:
The float value at the given index
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit, minus three

putFloat sample code for java.nio.ByteBuffer.putFloat(int, float) definition code for java.nio.ByteBuffer.putFloat(int, float)

public abstract ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  putFloat(int index,
                                    float value)
Absolute put method for writing a float value  (optional operation).

Writes four bytes containing the given float value, in the current byte order, into this buffer at the given index.

Parameters:
index - The index at which the bytes will be written
value - The float value to be written
Returns:
This buffer
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit, minus three
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

asFloatBuffer sample code for java.nio.ByteBuffer.asFloatBuffer() definition code for java.nio.ByteBuffer.asFloatBuffer()

public abstract FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer  asFloatBuffer()
Creates a view of this byte buffer as a float buffer.

The content of the new buffer will start at this buffer's current position. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by four, and its mark will be undefined. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

Returns:
A new float buffer

getDouble sample code for java.nio.ByteBuffer.getDouble() definition code for java.nio.ByteBuffer.getDouble()

public abstract double getDouble()
Relative get method for reading a double value.

Reads the next eight bytes at this buffer's current position, composing them into a double value according to the current byte order, and then increments the position by eight.

Returns:
The double value at the buffer's current position
Throws:
BufferUnderflowException sample code for java.nio.BufferUnderflowException definition code for java.nio.BufferUnderflowException - If there are fewer than eight bytes remaining in this buffer

putDouble sample code for java.nio.ByteBuffer.putDouble(double) definition code for java.nio.ByteBuffer.putDouble(double)

public abstract ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  putDouble(double value)
Relative put method for writing a double value  (optional operation).

Writes eight bytes containing the given double value, in the current byte order, into this buffer at the current position, and then increments the position by eight.

Parameters:
value - The double value to be written
Returns:
This buffer
Throws:
BufferOverflowException sample code for java.nio.BufferOverflowException definition code for java.nio.BufferOverflowException - If there are fewer than eight bytes remaining in this buffer
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

getDouble sample code for java.nio.ByteBuffer.getDouble(int) definition code for java.nio.ByteBuffer.getDouble(int)

public abstract double getDouble(int index)
Absolute get method for reading a double value.

Reads eight bytes at the given index, composing them into a double value according to the current byte order.

Parameters:
index - The index from which the bytes will be read
Returns:
The double value at the given index
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit, minus seven

putDouble sample code for java.nio.ByteBuffer.putDouble(int, double) definition code for java.nio.ByteBuffer.putDouble(int, double)

public abstract ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer  putDouble(int index,
                                     double value)
Absolute put method for writing a double value  (optional operation).

Writes eight bytes containing the given double value, in the current byte order, into this buffer at the given index.

Parameters:
index - The index at which the bytes will be written
value - The double value to be written
Returns:
This buffer
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit, minus seven
ReadOnlyBufferException sample code for java.nio.ReadOnlyBufferException definition code for java.nio.ReadOnlyBufferException - If this buffer is read-only

asDoubleBuffer sample code for java.nio.ByteBuffer.asDoubleBuffer() definition code for java.nio.ByteBuffer.asDoubleBuffer()

public abstract DoubleBuffer sample code for java.nio.DoubleBuffer definition code for java.nio.DoubleBuffer  asDoubleBuffer()
Creates a view of this byte buffer as a double buffer.

The content of the new buffer will start at this buffer's current position. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by eight, and its mark will be undefined. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

Returns:
A new double buffer