DoubleBuffer (gwt-nio 0.1 API)

java.lang.Object
- java.nio.Buffer
- - java.nio.DoubleBuffer

All Implemented Interfaces:

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

Method Summary

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

- Method Detail
  - array
```
public final double[] array()
```
    Returns the double array which this buffer is based on, if there is one.
    
    Returns:
    
    the double 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 double array which this buffer is based on, if there is one.
    The offset is the index of the array corresponding to the zero position of the buffer.
    
    Returns:
    
    the offset of the double 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 DoubleBuffer 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 that 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 DoubleBuffer compact()
```
    Compacts this double buffer.
    The remaining doubles 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(DoubleBuffer otherBuffer)
```
    Compare the remaining doubles of this buffer to another double buffer's remaining doubles.
    
    Specified by:
    
    compareTo in interface Comparable<DoubleBuffer>
    
    Parameters:
    
    otherBuffer - another double buffer.
    
    Returns:
    
    a negative value if this is less than other; 0 if this equals to other; a positive value if this is greater than other.
    
    Throws:
    
    ClassCastException - if other is not a double buffer.
  - duplicate
```
public abstract DoubleBuffer 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's. The duplicated buffer's read-only property and byte order are the 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 double buffer is equal to another object.
    If other is not a double buffer then false is returned. Two double buffers are equal if and only if their remaining doubles 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 double buffer.
    
    Returns:
    
    true if this double buffer is equal to other, false otherwise.
  - get
```
public abstract double get()
```
    Returns the double at the current position and increases the position by 1.
    
    Returns:
    
    the double at the current position.
    
    Throws:
    
    BufferUnderflowException - if the position is equal or greater than limit.
  - get
```
public DoubleBuffer get(double[] dest)
```
    Reads doubles from the current position into the specified double array and increases the position by the number of doubles read.
    Calling this method has the same effect as get(dest, 0, dest.length).
    
    Parameters:
    
    dest - the destination double array.
    
    Returns:
    
    this buffer.
    
    Throws:
    
    BufferUnderflowException - if dest.length is greater than remaining().
  - get
```
public DoubleBuffer get(double[] dest,
                        int off,
                        int len)
```
    Reads doubles from the current position into the specified double array, starting from the specified offset, and increases the position by the number of doubles read.
    
    Parameters:
    
    dest - the target double array.
    
    off - the offset of the double array, must not be negative and not greater than dest.length.
    
    len - the number of doubles 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 double get(int index)
```
    Returns a double at the specified index; the position is not changed.
    
    Parameters:
    
    index - the index, must not be negative and less than limit.
    
    Returns:
    
    a double at the specified index.
    
    Throws:
    
    IndexOutOfBoundsException - if index is invalid.
  - hasArray
```
public final boolean hasArray()
```
    Indicates whether this buffer is based on a double array and is read/write.
    
    Returns:
    
    true if this buffer is based on a double array and provides read/write access, false otherwise.
  - 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 double 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 doubles from/to bytes.
    If this buffer is not based on a byte buffer, then this always returns the platform's native byte order.
    
    Returns:
    
    the byte order used by this buffer when converting doubles from/to bytes.
  - put
```
public abstract DoubleBuffer put(double d)
```
    Writes the given double to the current position and increases the position by 1.
    
    Parameters:
    
    d - the double 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 DoubleBuffer put(double[] src)
```
    Writes doubles from the given double array to the current position and increases the position by the number of doubles written.
    Calling this method has the same effect as put(src, 0, src.length).
    
    Parameters:
    
    src - the source double 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 DoubleBuffer put(double[] src,
                        int off,
                        int len)
```
    Writes doubles from the given double array, starting from the specified offset, to the current position and increases the position by the number of doubles written.
    
    Parameters:
    
    src - the source double array.
    
    off - the offset of double array, must not be negative and not greater than src.length.
    
    len - the number of doubles 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 DoubleBuffer put(DoubleBuffer src)
```
    Writes all the remaining doubles of the src double buffer to this buffer's current position, and increases both buffers' position by the number of doubles copied.
    
    Parameters:
    
    src - the source double 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 DoubleBuffer put(int index,
                                 double d)
```
    Write a double to the specified index of this buffer and the position is not changed.
    
    Parameters:
    
    index - the index, must not be negative and less than the limit.
    
    d - the double to write.
    
    Returns:
    
    this buffer.
    
    Throws:
    
    IndexOutOfBoundsException - if index is invalid.
    
    ReadOnlyBufferException - if no changes may be made to the contents of this buffer.
  - slice
```
public abstract DoubleBuffer 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 the 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 double buffer.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representing the state of this double buffer.

Class DoubleBuffer

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

isDirect

order

put

put

put

put

put

slice

toString