ShortBuffer (gwt-nio 0.1 API)

java.lang.Object
- java.nio.Buffer
- - java.nio.ShortBuffer

All Implemented Interfaces:

Comparable<ShortBuffer>, HasArrayBufferView
```
public final class ShortBuffer
extends Buffer
implements Comparable<ShortBuffer>, HasArrayBufferView
```
A buffer of shorts.
A short buffer can be created in either of the following ways:
- Allocate a new short array and create a buffer based on it;
- Wrap an existing short array to create a new buffer;
- Use ByteBuffer.asShortBuffer to create a short buffer based on a byte buffer.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ShortBuffer`	`allocate(int capacity)` Creates a short buffer based on a newly allocated short array.
`ShortBuffer`	`compact()` Compacts this short buffer.
`int`	`compareTo(ShortBuffer otherBuffer)` Compare the remaining shorts of this buffer to another short buffer's remaining shorts.
`ShortBuffer`	`duplicate()` Returns a duplicated buffer that shares its content with this buffer.
`boolean`	`equals(Object other)` Checks whether this short buffer is equal to another object.
`short`	`get()` Returns the short at the current position and increases the position by 1.
`short`	`get(int index)` Returns the short at the specified index; the position is not changed.
`ShortBuffer`	`get(short[] dest)` Reads shorts from the current position into the specified short array and increases the position by the number of shorts read.
`ShortBuffer`	`get(short[] dest, int off, int len)` Reads shorts from the current position into the specified short array, starting from the specified offset, and increases the position by the number of shorts read.
`int`	`getElementSize()` Returns the element size in bytes (e.g.
`int`	`getElementType()` Returns the open GL element type constant corresponding to the buffer contents.
`elemental2.core.ArrayBufferView`	`getTypedArray()`
`boolean`	`hasArray()` Indicates whether this buffer is based on a short array and is read/write.
`int`	`hashCode()` Calculates this buffer's hash code from the remaining chars.
`boolean`	`isDirect()` Indicates whether this buffer is direct.
`boolean`	`isReadOnly()` Indicates whether this buffer is read-only.
`ByteOrder`	`order()` Returns the byte order used by this buffer when converting shorts from/to bytes.
`ShortBuffer`	`put(int index, short c)` Writes a short to the specified index of this buffer; the position is not changed.
`ShortBuffer`	`put(short c)` Writes the given short to the current position and increases the position by 1.
`ShortBuffer`	`put(short[] src)` Writes shorts from the given short array to the current position and increases the position by the number of shorts written.
`ShortBuffer`	`put(short[] src, int off, int len)` Writes shorts from the given short array, starting from the specified offset, to the current position and increases the position by the number of shorts written.
`ShortBuffer`	`put(ShortBuffer src)` Writes all the remaining shorts of the `src` short buffer to this buffer's current position, and increases both buffers' position by the number of shorts copied.
`ShortBuffer`	`slice()` Returns a sliced buffer that shares its content with this buffer.
`String`	`toString()` Returns a string representing the state of this short buffer.

Methods inherited from class java.nio.Buffer
capacity, clear, flip, hasRemaining, 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
  - allocate
```
public static ShortBuffer allocate(int capacity)
```
    Creates a short buffer based on a newly allocated short array.
    
    Parameters:
    
    capacity - the capacity of the new buffer.
    
    Returns:
    
    the created short buffer.
    
    Throws:
    
    IllegalArgumentException - if capacity is less than zero.
  - compact
```
public ShortBuffer compact()
```
    Compacts this short buffer.
    The remaining shorts will be moved to the head of the buffer, starting 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(ShortBuffer otherBuffer)
```
    Compare the remaining shorts of this buffer to another short buffer's remaining shorts.
    
    Specified by:
    
    compareTo in interface Comparable<ShortBuffer>
    
    Parameters:
    
    otherBuffer - another short 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 short buffer.
  - duplicate
```
public ShortBuffer 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 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 duplicated buffer that shares its content with this buffer.
  - equals
```
public boolean equals(Object other)
```
    Checks whether this short buffer is equal to another object.
    If other is not a short buffer then false is returned. Two short buffers are equal if and only if their remaining shorts 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 short buffer.
    
    Returns:
    
    true if this short buffer is equal to other, false otherwise.
  - get
```
public short get()
```
    Returns the short at the current position and increases the position by 1.
    
    Returns:
    
    the short at the current position.
    
    Throws:
    
    BufferUnderflowException - if the position is equal or greater than limit.
  - get
```
public ShortBuffer get(short[] dest)
```
    Reads shorts from the current position into the specified short array and increases the position by the number of shorts read.
    Calling this method has the same effect as get(dest, 0, dest.length).
    
    Parameters:
    
    dest - the destination short array.
    
    Returns:
    
    this buffer.
    
    Throws:
    
    BufferUnderflowException - if dest.length is greater than remaining().
  - get
```
public ShortBuffer get(short[] dest,
                       int off,
                       int len)
```
    Reads shorts from the current position into the specified short array, starting from the specified offset, and increases the position by the number of shorts read.
    
    Parameters:
    
    dest - the target short array.
    
    off - the offset of the short array, must not be negative and not greater than dest.length.
    
    len - the number of shorts 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 short get(int index)
```
    Returns the short at the specified index; the position is not changed.
    
    Parameters:
    
    index - the index, must not be negative and less than limit.
    
    Returns:
    
    a short at the specified index.
    
    Throws:
    
    IndexOutOfBoundsException - if index is invalid.
  - hasArray
```
public final boolean hasArray()
```
    Indicates whether this buffer is based on a short array and is read/write.
    
    Returns:
    
    true if this buffer is based on a short 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 shorts.
  - isDirect
```
public 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 short 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 ByteOrder order()
```
    Returns the byte order used by this buffer when converting shorts 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 shorts from/to bytes.
  - put
```
public ShortBuffer put(short c)
```
    Writes the given short to the current position and increases the position by 1.
    
    Parameters:
    
    s - the short 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 ShortBuffer put(short[] src)
```
    Writes shorts from the given short array to the current position and increases the position by the number of shorts written.
    Calling this method has the same effect as put(src, 0, src.length).
    
    Parameters:
    
    src - the source short 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 ShortBuffer put(short[] src,
                       int off,
                       int len)
```
    Writes shorts from the given short array, starting from the specified offset, to the current position and increases the position by the number of shorts written.
    
    Parameters:
    
    src - the source short array.
    
    off - the offset of short array, must not be negative and not greater than src.length.
    
    len - the number of shorts 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 ShortBuffer put(ShortBuffer src)
```
    Writes all the remaining shorts of the src short buffer to this buffer's current position, and increases both buffers' position by the number of shorts copied.
    
    Parameters:
    
    src - the source short 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 ShortBuffer put(int index,
                       short c)
```
    Writes a short 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.
    
    s - the short to write.
    
    Returns:
    
    this buffer.
    
    Throws:
    
    IndexOutOfBoundsException - if index is invalid.
    
    ReadOnlyBufferException - if no changes may be made to the contents of this buffer.
  - slice
```
public ShortBuffer 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 short buffer.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representing the state of this short buffer.
  - getTypedArray
```
public elemental2.core.ArrayBufferView getTypedArray()
```
    Specified by:
    
    getTypedArray in interface HasArrayBufferView
  - getElementSize
```
public int getElementSize()
```
    Description copied from interface: HasArrayBufferView
    
    Returns the element size in bytes (e.g. 4 for a FloatBuffer and 1 for a ByteBuffer).
    
    Specified by:
    
    getElementSize in interface HasArrayBufferView
  - getElementType
```
public int getElementType()
```
    Description copied from interface: HasArrayBufferView
    
    Returns the open GL element type constant corresponding to the buffer contents.
    
    Specified by:
    
    getElementType in interface HasArrayBufferView
  - isReadOnly
```
public boolean isReadOnly()
```
    Description copied from class: Buffer
    
    Indicates whether this buffer is read-only.
    
    Specified by:
    
    isReadOnly in class Buffer
    
    Returns:
    
    true if this buffer is read-only, false otherwise.

Class ShortBuffer

Method Summary

Methods inherited from class java.nio.Buffer

Methods inherited from class java.lang.Object

Method Detail

allocate

compact

compareTo

duplicate

equals

get

get

get

get

hasArray

hashCode

isDirect

order

put

put

put

put

put

slice

toString

getTypedArray

getElementSize

getElementType

isReadOnly