A direct byte buffer whose content is a memory-mapped region of a file.

Mapped byte buffers are created via the FileChannel.map method. This class extends the ByteBuffer class with operations that are specific to memory-mapped file regions.

A mapped byte buffer and the file mapping that it represents remain valid until the buffer itself is garbage-collected.

The content of a mapped byte buffer can change at any time, for example if the content of the corresponding region of the mapped file is changed by this program or another. Whether or not such changes occur, and when they occur, is operating-system dependent and therefore unspecified.

All or part of a mapped byte buffer may become inaccessible at any time, for example if the mapped file is truncated. An attempt to access an inaccessible region of a mapped byte buffer 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. It is therefore strongly recommended that appropriate precautions be taken to avoid the manipulation of a mapped file by this program, or by a concurrently running program, except to read or write the file's content.

Mapped byte buffers otherwise behave no differently than ordinary direct byte buffers.

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 , and its array offset will be zero.

Parameters
capacity The new buffer's capacity, in bytes
Return
The new byte buffer
Throws
IllegalArgumentException If the capacity is a negative integer
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 is unspecified.

Parameters
capacity The new buffer's capacity, in bytes
Return
The new byte buffer
Throws
IllegalArgumentException If the capacity is a negative integer
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 method before invoking this method in order to ensure that this buffer has an accessible backing array.

Return
The array that backs this buffer
Throws
ReadOnlyBufferException If this buffer is backed by an array but is read-only
UnsupportedOperationException If this buffer is not backed by an accessible array
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 method before invoking this method in order to ensure that this buffer has an accessible backing array.

Return
The offset within this buffer's array of the first element of the buffer
Throws
ReadOnlyBufferException If this buffer is backed by an array but is read-only
UnsupportedOperationException If this buffer is not backed by an accessible array
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.

Return
A new char buffer
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.

Return
A new double buffer
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.

Return
A new float buffer
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.

Return
A new int buffer
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.

Return
A new long buffer
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 method.

Return
The new, read-only byte buffer
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.

Return
A new short buffer
Returns this buffer's capacity.

Return
The capacity of this buffer
Clears this buffer. The position is set to zero, the limit is set to the capacity, and the mark is discarded.

Invoke this method before using a sequence of channel-read or put operations to fill this buffer. For example: 

 buf.clear();     // Prepare buffer for reading
 in.read(buf);    // Read data

This method does not actually erase the data in the buffer, but it is named as if it did because it will most often be used in situations in which that might as well be the case.

Return
This buffer
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
 }
Return
This buffer
Throws
ReadOnlyBufferException If this buffer is read-only
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.

Return
A negative integer, zero, or a positive integer as this buffer is less than, equal to, or greater than the given buffer
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.

Return
The new byte buffer
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.

Parameters
obThe object to which this buffer is to be compared
Return
true if, and only if, this buffer is equal to the given object
Flips this buffer. The limit is set to the current position and then the position is set to zero. If the mark is defined then it is discarded.

After a sequence of channel-read or put operations, invoke this method to prepare for a sequence of channel-write or relative get operations. For example: 

 buf.put(magic);    // Prepend header
 in.read(buf);      // Read data into rest of buffer
 buf.flip();        // Flip buffer
 out.write(buf);    // Write header + data to channel

This method is often used in conjunction with the compact method when transferring data from one place to another.

Return
This buffer
Forces any changes made to this buffer's content to be written to the storage device containing the mapped file.

If the file mapped into this buffer resides on a local storage device then when this method returns it is guaranteed that all changes made to the buffer since it was created, or since this method was last invoked, will have been written to that device.

If the file does not reside on a local device then no such guarantee is made.

If this buffer was not mapped in read/write mode (java.nio.channels.FileChannel.MapMode#READ_WRITE ) then invoking this method has no effect.

Return
This buffer
Relative get method. Reads the byte at this buffer's current position, and then increments the position.

Return
The byte at the buffer's current position
Throws
BufferUnderflowException If the buffer's current position is not smaller than its limit
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)
Return
This buffer
Throws
BufferUnderflowException If there are fewer than length bytes remaining in this buffer
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 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
Return
This buffer
Throws
BufferUnderflowException If there are fewer than length bytes remaining in this buffer
IndexOutOfBoundsException If the preconditions on the offset and length parameters do not hold
Absolute get method. Reads the byte at the given index.

Parameters
index The index from which the byte will be read
Return
The byte at the given index
Throws
IndexOutOfBoundsException If index is negative or not smaller than the buffer's limit
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.

Return
The char value at the buffer's current position
Throws
BufferUnderflowException If there are fewer than two bytes remaining in this buffer
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
Return
The char value at the given index
Throws
IndexOutOfBoundsException If index is negative or not smaller than the buffer's limit, minus one
Returns the runtime class of an object. That Class object is the object that is locked by static synchronized methods of the represented class.
Return
The java.lang.Class object that represents the runtime class of the object. The result is of type {@code Class} where X is the erasure of the static type of the expression on which getClass is called.
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.

Return
The double value at the buffer's current position
Throws
BufferUnderflowException If there are fewer than eight bytes remaining in this buffer
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
Return
The double value at the given index
Throws
IndexOutOfBoundsException If index is negative or not smaller than the buffer's limit, minus seven
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.

Return
The float value at the buffer's current position
Throws
BufferUnderflowException If there are fewer than four bytes remaining in this buffer
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
Return
The float value at the given index
Throws
IndexOutOfBoundsException If index is negative or not smaller than the buffer's limit, minus three
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.

Return
The int value at the buffer's current position
Throws
BufferUnderflowException If there are fewer than four bytes remaining in this buffer
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
Return
The int value at the given index
Throws
IndexOutOfBoundsException If index is negative or not smaller than the buffer's limit, minus three
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.

Return
The long value at the buffer's current position
Throws
BufferUnderflowException If there are fewer than eight bytes remaining in this buffer
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
Return
The long value at the given index
Throws
IndexOutOfBoundsException If index is negative or not smaller than the buffer's limit, minus seven
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.

Return
The short value at the buffer's current position
Throws
BufferUnderflowException If there are fewer than two bytes remaining in this buffer
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
Return
The short value at the given index
Throws
IndexOutOfBoundsException If index is negative or not smaller than the buffer's limit, minus one
Tells whether or not this buffer is backed by an accessible byte array.

If this method returns true then the array and arrayOffset methods may safely be invoked.

Return
true if, and only if, this buffer is backed by an array and is not read-only
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.

Return
The current hash code of this buffer
Tells whether there are any elements between the current position and the limit.

Return
true if, and only if, there is at least one element remaining in this buffer
Tells whether or not this byte buffer is direct.

Return
true if, and only if, this buffer is direct
Tells whether or not this buffer's content is resident in physical memory.

A return value of true implies that it is highly likely that all of the data in this buffer is resident in physical memory and may therefore be accessed without incurring any virtual-memory page faults or I/O operations. A return value of false does not necessarily imply that the buffer's content is not resident in physical memory.

The returned value is a hint, rather than a guarantee, because the underlying operating system may have paged out some of the buffer's data by the time that an invocation of this method returns.

Return
true if it is likely that this buffer's content is resident in physical memory
Tells whether or not this buffer is read-only.

Return
true if, and only if, this buffer is read-only
Returns this buffer's limit.

Return
The limit of this buffer
Sets this buffer's limit. If the position is larger than the new limit then it is set to the new limit. If the mark is defined and larger than the new limit then it is discarded.

Parameters
newLimit The new limit value; must be non-negative and no larger than this buffer's capacity
Return
This buffer
Throws
IllegalArgumentException If the preconditions on newLimit do not hold
Loads this buffer's content into physical memory.

This method makes a best effort to ensure that, when it returns, this buffer's content is resident in physical memory. Invoking this method may cause some number of page faults and I/O operations to occur.

Return
This buffer
Sets this buffer's mark at its position.

Return
This buffer
Wakes up a single thread that is waiting on this object's monitor. If any threads are waiting on this object, one of them is chosen to be awakened. The choice is arbitrary and occurs at the discretion of the implementation. A thread waits on an object's monitor by calling one of the wait methods.

The awakened thread will not be able to proceed until the current thread relinquishes the lock on this object. The awakened thread will compete in the usual manner with any other threads that might be actively competing to synchronize on this object; for example, the awakened thread enjoys no reliable privilege or disadvantage in being the next thread to lock this object.

This method should only be called by a thread that is the owner of this object's monitor. A thread becomes the owner of the object's monitor in one of three ways:

  • By executing a synchronized instance method of that object.
  • By executing the body of a synchronized statement that synchronizes on the object.
  • For objects of type Class, by executing a synchronized static method of that class.

Only one thread at a time can own an object's monitor.

Throws
IllegalMonitorStateExceptionif the current thread is not the owner of this object's monitor.
See Also
java.lang.Object#notifyAll() , java.lang.Object#wait()
Wakes up all threads that are waiting on this object's monitor. A thread waits on an object's monitor by calling one of the wait methods.

The awakened threads will not be able to proceed until the current thread relinquishes the lock on this object. The awakened threads will compete in the usual manner with any other threads that might be actively competing to synchronize on this object; for example, the awakened threads enjoy no reliable privilege or disadvantage in being the next thread to lock this object.

This method should only be called by a thread that is the owner of this object's monitor. See the notify method for a description of the ways in which a thread can become the owner of a monitor.

Throws
IllegalMonitorStateExceptionif the current thread is not the owner of this object's monitor.
See Also
java.lang.Object#notify() , java.lang.Object#wait()
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 .

Return
This buffer's byte order
Modifies this buffer's byte order.

Parameters
bo The new byte order, either {@link ByteOrder#BIG_ENDIAN BIG_ENDIAN} or {@link ByteOrder#LITTLE_ENDIAN LITTLE_ENDIAN}
Return
This buffer
Returns this buffer's position.

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

Parameters
newPosition The new position value; must be non-negative and no larger than the current limit
Return
This buffer
Throws
IllegalArgumentException If the preconditions on newPosition do not hold
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
Return
This buffer
Throws
BufferOverflowException If this buffer's current position is not smaller than its limit
ReadOnlyBufferException If this buffer is read-only
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)
Return
This buffer
Throws
BufferOverflowException If there is insufficient space in this buffer
ReadOnlyBufferException If this buffer is read-only
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 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
Return
This buffer
Throws
BufferOverflowException If there is insufficient space in this buffer
IndexOutOfBoundsException If the preconditions on the offset and length parameters do not hold
ReadOnlyBufferException If this buffer is read-only
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 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
Return
This buffer
Throws
BufferOverflowException If there is insufficient space in this buffer for the remaining bytes in the source buffer
IllegalArgumentException If the source buffer is this buffer
ReadOnlyBufferException If this buffer is read-only
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
Return
This buffer
Throws
IndexOutOfBoundsException If index is negative or not smaller than the buffer's limit
ReadOnlyBufferException If this buffer is read-only
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
Return
This buffer
Throws
BufferOverflowException If there are fewer than two bytes remaining in this buffer
ReadOnlyBufferException If this buffer is read-only
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
Return
This buffer
Throws
IndexOutOfBoundsException If index is negative or not smaller than the buffer's limit, minus one
ReadOnlyBufferException If this buffer is read-only
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
Return
This buffer
Throws
BufferOverflowException If there are fewer than eight bytes remaining in this buffer
ReadOnlyBufferException If this buffer is read-only
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
Return
This buffer
Throws
IndexOutOfBoundsException If index is negative or not smaller than the buffer's limit, minus seven
ReadOnlyBufferException If this buffer is read-only
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
Return
This buffer
Throws
BufferOverflowException If there are fewer than four bytes remaining in this buffer
ReadOnlyBufferException If this buffer is read-only
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
Return
This buffer
Throws
IndexOutOfBoundsException If index is negative or not smaller than the buffer's limit, minus three
ReadOnlyBufferException If this buffer is read-only
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
Return
This buffer
Throws
BufferOverflowException If there are fewer than four bytes remaining in this buffer
ReadOnlyBufferException If this buffer is read-only
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
Return
This buffer
Throws
IndexOutOfBoundsException If index is negative or not smaller than the buffer's limit, minus three
ReadOnlyBufferException If this buffer is read-only
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
Return
This buffer
Throws
IndexOutOfBoundsException If index is negative or not smaller than the buffer's limit, minus seven
ReadOnlyBufferException If this buffer is read-only
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
Return
This buffer
Throws
BufferOverflowException If there are fewer than eight bytes remaining in this buffer
ReadOnlyBufferException If this buffer is read-only
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
Return
This buffer
Throws
IndexOutOfBoundsException If index is negative or not smaller than the buffer's limit, minus one
ReadOnlyBufferException If this buffer is read-only
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
Return
This buffer
Throws
BufferOverflowException If there are fewer than two bytes remaining in this buffer
ReadOnlyBufferException If this buffer is read-only
Returns the number of elements between the current position and the limit.

Return
The number of elements remaining in this buffer
Resets this buffer's position to the previously-marked position.

Invoking this method neither changes nor discards the mark's value.

Return
This buffer
Throws
InvalidMarkException If the mark has not been set
Rewinds this buffer. The position is set to zero and the mark is discarded.

Invoke this method before a sequence of channel-write or get operations, assuming that the limit has already been set appropriately. For example: 

 out.write(buf);    // Write remaining data
 buf.rewind();      // Rewind buffer
 buf.get(array);    // Copy data into array
Return
This buffer
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.

Return
The new byte buffer
Returns a string summarizing the state of this buffer.

Return
A summary string
Causes current thread to wait until another thread invokes the method or the method for this object. In other words, this method behaves exactly as if it simply performs the call wait(0).

The current thread must own this object's monitor. The thread releases ownership of this monitor and waits until another thread notifies threads waiting on this object's monitor to wake up either through a call to the notify method or the notifyAll method. The thread then waits until it can re-obtain ownership of the monitor and resumes execution.

As in the one argument version, interrupts and spurious wakeups are possible, and this method should always be used in a loop: 

     synchronized (obj) {
         while (<condition does not hold>)
             obj.wait();
         ... // Perform action appropriate to condition
     }
This method should only be called by a thread that is the owner of this object's monitor. See the notify method for a description of the ways in which a thread can become the owner of a monitor.
Throws
IllegalMonitorStateExceptionif the current thread is not the owner of the object's monitor.
InterruptedExceptionif another thread interrupted the current thread before or while the current thread was waiting for a notification. The interrupted status of the current thread is cleared when this exception is thrown.
See Also
java.lang.Object#notify() , java.lang.Object#notifyAll()
Causes current thread to wait until either another thread invokes the method or the method for this object, or a specified amount of time has elapsed.

The current thread must own this object's monitor.

This method causes the current thread (call it T) to place itself in the wait set for this object and then to relinquish any and all synchronization claims on this object. Thread T becomes disabled for thread scheduling purposes and lies dormant until one of four things happens:

  • Some other thread invokes the notify method for this object and thread T happens to be arbitrarily chosen as the thread to be awakened.
  • Some other thread invokes the notifyAll method for this object.
  • Some other thread interrupts thread T.
  • The specified amount of real time has elapsed, more or less. If timeout is zero, however, then real time is not taken into consideration and the thread simply waits until notified.
The thread T is then removed from the wait set for this object and re-enabled for thread scheduling. It then competes in the usual manner with other threads for the right to synchronize on the object; once it has gained control of the object, all its synchronization claims on the object are restored to the status quo ante - that is, to the situation as of the time that the wait method was invoked. Thread T then returns from the invocation of the wait method. Thus, on return from the wait method, the synchronization state of the object and of thread T is exactly as it was when the wait method was invoked.

A thread can also wake up without being notified, interrupted, or timing out, a so-called spurious wakeup. While this will rarely occur in practice, applications must guard against it by testing for the condition that should have caused the thread to be awakened, and continuing to wait if the condition is not satisfied. In other words, waits should always occur in loops, like this one: 

     synchronized (obj) {
         while (<condition does not hold>)
             obj.wait(timeout);
         ... // Perform action appropriate to condition
     }
(For more information on this topic, see Section 3.2.3 in Doug Lea's "Concurrent Programming in Java (Second Edition)" (Addison-Wesley, 2000), or Item 50 in Joshua Bloch's "Effective Java Programming Language Guide" (Addison-Wesley, 2001).

If the current thread is interrupted by another thread while it is waiting, then an InterruptedException is thrown. This exception is not thrown until the lock status of this object has been restored as described above.

Note that the wait method, as it places the current thread into the wait set for this object, unlocks only this object; any other objects on which the current thread may be synchronized remain locked while the thread waits.

This method should only be called by a thread that is the owner of this object's monitor. See the notify method for a description of the ways in which a thread can become the owner of a monitor.

Parameters
timeoutthe maximum time to wait in milliseconds.
Throws
IllegalArgumentExceptionif the value of timeout is negative.
IllegalMonitorStateExceptionif the current thread is not the owner of the object's monitor.
InterruptedExceptionif another thread interrupted the current thread before or while the current thread was waiting for a notification. The interrupted status of the current thread is cleared when this exception is thrown.
See Also
java.lang.Object#notify() , java.lang.Object#notifyAll()
Causes current thread to wait until another thread invokes the method or the method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.

This method is similar to the wait method of one argument, but it allows finer control over the amount of time to wait for a notification before giving up. The amount of real time, measured in nanoseconds, is given by: 

 1000000*timeout+nanos

In all other respects, this method does the same thing as the method of one argument. In particular, wait(0, 0) means the same thing as wait(0).

The current thread must own this object's monitor. The thread releases ownership of this monitor and waits until either of the following two conditions has occurred:

  • Another thread notifies threads waiting on this object's monitor to wake up either through a call to the notify method or the notifyAll method.
  • The timeout period, specified by timeout milliseconds plus nanos nanoseconds arguments, has elapsed.

The thread then waits until it can re-obtain ownership of the monitor and resumes execution.

As in the one argument version, interrupts and spurious wakeups are possible, and this method should always be used in a loop: 

     synchronized (obj) {
         while (<condition does not hold>)
             obj.wait(timeout, nanos);
         ... // Perform action appropriate to condition
     }
This method should only be called by a thread that is the owner of this object's monitor. See the notify method for a description of the ways in which a thread can become the owner of a monitor.
Parameters
timeoutthe maximum time to wait in milliseconds.
nanosadditional time, in nanoseconds range 0-999999.
Throws
IllegalArgumentExceptionif the value of timeout is negative or the value of nanos is not in the range 0-999999.
IllegalMonitorStateExceptionif the current thread is not the owner of this object's monitor.
InterruptedExceptionif another thread interrupted the current thread before or while the current thread was waiting for a notification. The interrupted status of the current thread is cleared when this exception is thrown.
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 will be the given array, and its array offset will be zero.

Parameters
array The array that will back this buffer
Return
The new byte buffer
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 will be the given array, and its array offset 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.
Return
The new byte buffer
Throws
IndexOutOfBoundsException If the preconditions on the offset and length parameters do not hold