LongBuffer (gwt-nio 0.1 API)

java.lang.Object
- java.nio.Buffer
- - java.nio.LongBuffer

All Implemented Interfaces:

Comparable<LongBuffer>
```
public abstract class LongBuffer
extends Buffer
implements Comparable<LongBuffer>
```
A buffer of longs.
A long buffer can be created in either of the following ways:
- Allocate a new long array and create a buffer based on it;
- Wrap an existing long array to create a new buffer;
- Use ByteBuffer.asLongBuffer to create a long buffer based on a byte buffer.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`long[]`	`array()` Returns the long array which this buffer is based on, if there is one.
`int`	`arrayOffset()` Returns the offset of the long array which this buffer is based on, if there is one.
`abstract LongBuffer`	`asReadOnlyBuffer()` Returns a read-only buffer that shares its content with this buffer.
`abstract LongBuffer`	`compact()` Compacts this long buffer.
`int`	`compareTo(LongBuffer otherBuffer)` Compare the remaining longs of this buffer to another long buffer's remaining longs.
`abstract LongBuffer`	`duplicate()` Returns a duplicated buffer that shares its content with this buffer.
`boolean`	`equals(Object other)` Checks whether this long buffer is equal to another object.
`abstract long`	`get()` Returns the long at the current position and increase the position by 1.
`abstract long`	`get(int index)` Returns the long at the specified index; the position is not changed.
`LongBuffer`	`get(long[] dest)` Reads longs from the current position into the specified long array and increases the position by the number of longs read.
`LongBuffer`	`get(long[] dest, int off, int len)` Reads longs from the current position into the specified long array, starting from the specified offset, and increase the position by the number of longs read.
`boolean`	`hasArray()` Indicates whether this buffer is based on a long array and is read/write.
`int`	`hashCode()` Calculates this buffer's hash code from the remaining chars.
`abstract boolean`	`isDirect()` Indicates whether this buffer is direct.
`abstract ByteOrder`	`order()` Returns the byte order used by this buffer when converting longs from/to bytes.
`abstract LongBuffer`	`put(int index, long l)` Writes a long to the specified index of this buffer; the position is not changed.
`abstract LongBuffer`	`put(long l)` Writes the given long to the current position and increases the position by 1.
`LongBuffer`	`put(long[] src)` Writes longs from the given long array to the current position and increases the position by the number of longs written.
`LongBuffer`	`put(long[] src, int off, int len)` Writes longs from the given long array, starting from the specified offset, to the current position and increases the position by the number of longs written.
`LongBuffer`	`put(LongBuffer src)` Writes all the remaining longs of the `src` long buffer to this buffer's current position, and increases both buffers' position by the number of longs copied.
`abstract LongBuffer`	`slice()` Returns a sliced buffer that shares its content with this buffer.
`String`	`toString()` Returns a string representing the state of this long buffer.

Methods inherited from class java.nio.Buffer
capacity, clear, flip, hasRemaining, isReadOnly, limit, limit, mark, position, position, remaining, reset, rewind

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - array
```
public final long[] array()
```
    Returns the long array which this buffer is based on, if there is one.
    
    Returns:
    
    the long array which this buffer is based on.
    
    Throws:
    
    ReadOnlyBufferException - if this buffer is based on an array, but it is read-only.
    
    UnsupportedOperationException - if this buffer is not based on an array.
  - arrayOffset
```
public final int arrayOffset()
```
    Returns the offset of the long array which this buffer is based on, if there is one.
    The offset is the index of the array and corresponds to the zero position of the buffer.
    
    Returns:
    
    the offset of the long array which this buffer is based on.
    
    Throws:
    
    ReadOnlyBufferException - if this buffer is based on an array, but it is read-only.
    
    UnsupportedOperationException - if this buffer is not based on an array.
  - asReadOnlyBuffer
```
public abstract LongBuffer asReadOnlyBuffer()
```
    Returns a read-only buffer that shares its content with this buffer.
    The returned buffer is guaranteed to be a new instance, even if this buffer is read-only itself. The new buffer's position, limit, capacity and mark are the same as this buffer's.
    
    The new buffer shares its content with this buffer, which means this buffer's change of content will be visible to the new buffer. The two buffer's position, limit and mark are independent.
    
    Returns:
    
    a read-only version of this buffer.
  - compact
```
public abstract LongBuffer compact()
```
    Compacts this long buffer.
    The remaining longs will be moved to the head of the buffer, staring from position zero. Then the position is set to remaining(); the limit is set to capacity; the mark is cleared.
    
    Returns:
    
    this buffer.
    
    Throws:
    
    ReadOnlyBufferException - if no changes may be made to the contents of this buffer.
  - compareTo
```
public int compareTo(LongBuffer otherBuffer)
```
    Compare the remaining longs of this buffer to another long buffer's remaining longs.
    
    Specified by:
    
    compareTo in interface Comparable<LongBuffer>
    
    Parameters:
    
    otherBuffer - another long buffer.
    
    Returns:
    
    a negative value if this is less than otherBuffer; 0 if this equals to otherBuffer; a positive value if this is greater than otherBuffer
    
    Throws:
    
    ClassCastException - if otherBuffer is not a long buffer.
  - duplicate
```
public abstract LongBuffer duplicate()
```
    Returns a duplicated buffer that shares its content with this buffer.
    The duplicated buffer's position, limit, capacity and mark are the same as this buffer. The duplicated buffer's read-only property and byte order are same as this buffer's, too.
    
    The new buffer shares its content with this buffer, which means either buffer's change of content will be visible to the other. The two buffer's position, limit and mark are independent.
    
    Returns:
    
    a duplicated buffer that shares its content with this buffer.
  - equals
```
public boolean equals(Object other)
```
    Checks whether this long buffer is equal to another object.
    If other is not a long buffer then false is returned. Two long buffers are equal if and only if their remaining longs are exactly the same. Position, limit, capacity and mark are not considered.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    other - the object to compare with this long buffer.
    
    Returns:
    
    true if this long buffer is equal to other, false otherwise.
  - get
```
public abstract long get()
```
    Returns the long at the current position and increase the position by 1.
    
    Returns:
    
    the long at the current position.
    
    Throws:
    
    BufferUnderflowException - if the position is equal or greater than limit.
  - get
```
public LongBuffer get(long[] dest)
```
    Reads longs from the current position into the specified long array and increases the position by the number of longs read.
    Calling this method has the same effect as get(dest, 0, dest.length).
    
    Parameters:
    
    dest - the destination long array.
    
    Returns:
    
    this buffer.
    
    Throws:
    
    BufferUnderflowException - if dest.length is greater than remaining().
  - get
```
public LongBuffer get(long[] dest,
                      int off,
                      int len)
```
    Reads longs from the current position into the specified long array, starting from the specified offset, and increase the position by the number of longs read.
    
    Parameters:
    
    dest - the target long array.
    
    off - the offset of the long array, must not be negative and not greater than dest.length.
    
    len - the number of longs to read, must be no less than zero and not greater than dest.length - off.
    
    Returns:
    
    this buffer.
    
    Throws:
    
    IndexOutOfBoundsException - if either off or len is invalid.
    
    BufferUnderflowException - if len is greater than remaining().
  - get
```
public abstract long get(int index)
```
    Returns the long at the specified index; the position is not changed.
    
    Parameters:
    
    index - the index, must not be negative and less than limit.
    
    Returns:
    
    the long at the specified index.
    
    Throws:
    
    IndexOutOfBoundsException - if index is invalid.
  - hasArray
```
public final boolean hasArray()
```
    Indicates whether this buffer is based on a long array and is read/write.
    
    Returns:
    
    true if this buffer is based on a long array and provides read/write access, false otherwise.
  - hashCode
```
public int hashCode()
```
    Calculates this buffer's hash code from the remaining chars. The position, limit, capacity and mark don't affect the hash code.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hash code calculated from the remaining longs.
  - isDirect
```
public abstract boolean isDirect()
```
    Indicates whether this buffer is direct. A direct buffer will try its best to take advantage of native memory APIs and it may not stay in the Java heap, so it is not affected by garbage collection.
    A long buffer is direct if it is based on a byte buffer and the byte buffer is direct.
    
    Returns:
    
    true if this buffer is direct, false otherwise.
  - order
```
public abstract ByteOrder order()
```
    Returns the byte order used by this buffer when converting longs from/to bytes.
    If this buffer is not based on a byte buffer, then always return the platform's native byte order.
    
    Returns:
    
    the byte order used by this buffer when converting longs from/to bytes.
  - put
```
public abstract LongBuffer put(long l)
```
    Writes the given long to the current position and increases the position by 1.
    
    Parameters:
    
    l - the long to write.
    
    Returns:
    
    this buffer.
    
    Throws:
    
    BufferOverflowException - if position is equal or greater than limit.
    
    ReadOnlyBufferException - if no changes may be made to the contents of this buffer.
  - put
```
public final LongBuffer put(long[] src)
```
    Writes longs from the given long array to the current position and increases the position by the number of longs written.
    Calling this method has the same effect as put(src, 0, src.length).
    
    Parameters:
    
    src - the source long array.
    
    Returns:
    
    this buffer.
    
    Throws:
    
    BufferOverflowException - if remaining() is less than src.length.
    
    ReadOnlyBufferException - if no changes may be made to the contents of this buffer.
  - put
```
public LongBuffer put(long[] src,
                      int off,
                      int len)
```
    Writes longs from the given long array, starting from the specified offset, to the current position and increases the position by the number of longs written.
    
    Parameters:
    
    src - the source long array.
    
    off - the offset of long array, must not be negative and not greater than src.length.
    
    len - the number of longs to write, must be no less than zero and not greater than src.length - off.
    
    Returns:
    
    this buffer.
    
    Throws:
    
    BufferOverflowException - if remaining() is less than len.
    
    IndexOutOfBoundsException - if either off or len is invalid.
    
    ReadOnlyBufferException - if no changes may be made to the contents of this buffer.
  - put
```
public LongBuffer put(LongBuffer src)
```
    Writes all the remaining longs of the src long buffer to this buffer's current position, and increases both buffers' position by the number of longs copied.
    
    Parameters:
    
    src - the source long buffer.
    
    Returns:
    
    this buffer.
    
    Throws:
    
    BufferOverflowException - if src.remaining() is greater than this buffer's remaining().
    
    IllegalArgumentException - if src is this buffer.
    
    ReadOnlyBufferException - if no changes may be made to the contents of this buffer.
  - put
```
public abstract LongBuffer put(int index,
                               long l)
```
    Writes a long to the specified index of this buffer; the position is not changed.
    
    Parameters:
    
    index - the index, must not be negative and less than the limit.
    
    l - the long to write.
    
    Returns:
    
    this buffer.
    
    Throws:
    
    IndexOutOfBoundsException - if index is invalid.
    
    ReadOnlyBufferException - if no changes may be made to the contents of this buffer.
  - slice
```
public abstract LongBuffer slice()
```
    Returns a sliced buffer that shares its content with this buffer.
    The sliced buffer's capacity will be this buffer's remaining(), and its zero position will correspond to this buffer's current position. The new buffer's position will be 0, limit will be its capacity, and its mark is cleared. The new buffer's read-only property and byte order are same as this buffer's.
    
    The new buffer shares its content with this buffer, which means either buffer's change of content will be visible to the other. The two buffer's position, limit and mark are independent.
    
    Returns:
    
    a sliced buffer that shares its content with this buffer.
  - toString
```
public String toString()
```
    Returns a string representing the state of this long buffer.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representing the state of this long buffer.

Class LongBuffer

Method Summary

Methods inherited from class java.nio.Buffer

Methods inherited from class java.lang.Object

Method Detail

array

arrayOffset

asReadOnlyBuffer

compact

compareTo

duplicate

equals

get

get

get

get

hasArray

hashCode

isDirect

order

put

put

put

put

put

slice

toString