# ShortBuffer
public abstract class **ShortBuffer** extends [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html)
implements [Comparable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Comparable.html)\<[ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html)\> A short buffer.
This class defines four categories of operations upon
short buffers:
- Absolute and relative `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#get()` and
`https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#put(short)` methods that read and write
single shorts;
- Relative `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#get(short[])`
methods that transfer contiguous sequences of shorts from this buffer
into an array; and
- Relative `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#put(short[])`
methods that transfer contiguous sequences of shorts from a
short array or some other short
buffer into this buffer; and
- Methods for `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#compact()`, `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#duplicate()`, and `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#slice()`
a short buffer.
Short buffers can be created either by `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#allocate(int)`, which allocates space for the buffer's
content, by `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#wrap(short[])` an existing
short array into a buffer, or by creating a
[*view*](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ByteBuffer#views) of an existing byte buffer.
Like a byte buffer, a short buffer is either [*direct* or *non-direct*](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ByteBuffer#direct). A
short buffer created via the wrap methods of this class will
be non-direct. A short buffer created as a view of a byte buffer will
be direct if, and only if, the byte buffer itself is direct. Whether or not
a short buffer is direct may be determined by invoking the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#isDirect()` method.
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.
### Public Method Summary
|---|---|
| static [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html) | [allocate](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#allocate(int))(int capacity) Allocates a new short buffer. |
| final short\[\] | [array](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#array())() Returns the short array that backs this buffer *(optional operation)*. |
| final int | [arrayOffset](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#arrayOffset())() Returns the offset within this buffer's backing array of the first element of the buffer *(optional operation)*. |
| abstract [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html) | [asReadOnlyBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#asReadOnlyBuffer())() Creates a new, read-only short buffer that shares this buffer's content. |
| [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html) | [clear](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#clear())() Clears this buffer. |
| abstract [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html) | [compact](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#compact())() Compacts this buffer *(optional operation)*. |
| int | [compareTo](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#compareTo(java.nio.ShortBuffer))([ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html) that) Compares this buffer to another. |
| abstract [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html) | [duplicate](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#duplicate())() Creates a new short buffer that shares this buffer's content. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) ob) Tells whether or not this buffer is equal to another object. |
| [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html) | [flip](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#flip())() Flips this buffer. |
| abstract short | [get](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#get())() Relative *get* method. |
| [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html) | [get](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#get(short[],%20int,%20int))(short\[\] dst, int offset, int length) Relative bulk *get* method. |
| [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html) | [get](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#get(short[]))(short\[\] dst) Relative bulk *get* method. |
| abstract short | [get](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#get(int))(int index) Absolute *get* method. |
| final boolean | [hasArray](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#hasArray())() Tells whether or not this buffer is backed by an accessible short array. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#hashCode())() Returns the current hash code of this buffer. |
| abstract boolean | [isDirect](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#isDirect())() Tells whether or not this short buffer is direct. |
| [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html) | [limit](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#limit(int))(int newLimit) Sets this buffer's limit. |
| [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html) | [mark](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#mark())() Sets this buffer's mark at its position. |
| abstract [ByteOrder](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ByteOrder.html) | [order](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#order())() Retrieves this buffer's byte order. |
| [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html) | [position](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#position(int))(int newPosition) Sets this buffer's position. |
| [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html) | [put](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#put(short[],%20int,%20int))(short\[\] src, int offset, int length) Relative bulk *put* method *(optional operation)*. |
| final [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html) | [put](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#put(short[]))(short\[\] src) Relative bulk *put* method *(optional operation)*. |
| abstract [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html) | [put](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#put(short))(short s) Relative *put* method *(optional operation)*. |
| abstract [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html) | [put](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#put(int,%20short))(int index, short s) Absolute *put* method *(optional operation)*. |
| [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html) | [put](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#put(java.nio.ShortBuffer))([ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html) src) Relative bulk *put* method *(optional operation)*. |
| [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html) | [reset](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#reset())() Resets this buffer's position to the previously-marked position. |
| [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html) | [rewind](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#rewind())() Rewinds this buffer. |
| abstract [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html) | [slice](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#slice())() Creates a new short buffer whose content is a shared subsequence of this buffer's content. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#toString())() Returns a string summarizing the state of this buffer. |
| static [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html) | [wrap](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#wrap(short[],%20int,%20int))(short\[\] array, int offset, int length) Wraps a short array into a buffer. |
| static [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html) | [wrap](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#wrap(short[]))(short\[\] array) Wraps a short array into a buffer. |
### Inherited Method Summary
From class [java.nio.Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html)
|---|---|
| abstract [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [array](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#array())() Returns the array that backs this buffer *(optional operation)*. |
| abstract int | [arrayOffset](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#arrayOffset())() Returns the offset within this buffer's backing array of the first element of the buffer *(optional operation)*. |
| final int | [capacity](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#capacity())() Returns this buffer's capacity. |
| [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html) | [clear](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#clear())() Clears this buffer. |
| [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html) | [flip](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#flip())() Flips this buffer. |
| abstract boolean | [hasArray](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#hasArray())() Tells whether or not this buffer is backed by an accessible array. |
| final boolean | [hasRemaining](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#hasRemaining())() Tells whether there are any elements between the current position and the limit. |
| abstract boolean | [isDirect](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#isDirect())() Tells whether or not this buffer is [*direct*](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ByteBuffer#direct). |
| abstract boolean | [isReadOnly](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#isReadOnly())() Tells whether or not this buffer is read-only. |
| final int | [limit](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#limit())() Returns this buffer's limit. |
| [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html) | [limit](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#limit(int))(int newLimit) Sets this buffer's limit. |
| [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html) | [mark](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#mark())() Sets this buffer's mark at its position. |
| [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html) | [position](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#position(int))(int newPosition) Sets this buffer's position. |
| final int | [position](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#position())() Returns this buffer's position. |
| final int | [remaining](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#remaining())() Returns the number of elements between the current position and the limit. |
| [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html) | [reset](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#reset())() Resets this buffer's position to the previously-marked position. |
| [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html) | [rewind](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html#rewind())() Rewinds this buffer. |
From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)
|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\ | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |
From interface [java.lang.Comparable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Comparable.html)
|---|---|
| abstract int | [compareTo](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Comparable.html#compareTo(T))([ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html) o) Compares this object with the specified object for order. |
## Public Methods
#### public static [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html)
**allocate**
(int capacity)
Allocates a new short buffer.
The new buffer's position will be zero, its limit will be its
capacity, its mark will be undefined, and each of its elements will be
initialized to zero. It will have a `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#array()`,
and its `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#arrayOffset()` will be zero.
##### Parameters
| capacity | The new buffer's capacity, in shorts |
|---|---|
##### Returns
- The new short buffer
##### Throws
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | If the capacity is a negative integer |
|---|---|
#### public final short\[\]
**array**
()
Returns the short 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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#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](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ReadOnlyBufferException.html) | If this buffer is backed by an array but is read-only |
| [UnsupportedOperationException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/UnsupportedOperationException.html) | If this buffer is not backed by an accessible array |
|---|---|
#### 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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#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](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ReadOnlyBufferException.html) | If this buffer is backed by an array but is read-only |
| [UnsupportedOperationException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/UnsupportedOperationException.html) | If this buffer is not backed by an accessible array |
|---|---|
#### public abstract [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html)
**asReadOnlyBuffer**
()
Creates a new, read-only short 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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#duplicate()` method.
##### Returns
- The new, read-only short buffer
#### public [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html)
**clear**
()
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.
##### Returns
- This buffer
#### public abstract [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html)
**compact**
()
Compacts this buffer *(optional operation)*.
The shorts between the buffer's current position and its limit,
if any, are copied to the beginning of the buffer. That is, the
short at index *p* = position() is copied
to index zero, the short at index *p* + 1 is copied
to index one, and so forth until the short 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 shorts copied,
rather than to zero, so that an invocation of this method can be
followed immediately by an invocation of another relative *put*
method.
##### Returns
- This buffer
##### Throws
| [ReadOnlyBufferException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ReadOnlyBufferException.html) | If this buffer is read-only |
|---|---|
#### public int
**compareTo**
([ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html) that)
Compares this buffer to another.
Two short buffers are compared by comparing their sequences of
remaining elements lexicographically, without regard to the starting
position of each sequence within its corresponding buffer.
Pairs of `short` elements are compared as if by invoking
`https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Short.html#compare(short,%20short)`.
A short buffer is not comparable to any other type of object.
##### Parameters
| that | |
|---|---|
##### Returns
- A negative integer, zero, or a positive integer as this buffer is less than, equal to, or greater than the given buffer
#### public abstract [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html)
**duplicate**
()
Creates a new short 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 short buffer
#### public boolean
**equals**
([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) ob)
Tells whether or not this buffer is equal to another object.
Two short 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 short buffer is not equal to any other type of 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
#### public [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html)
**flip**
()
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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ByteBuffer.html#compact()` method when transferring data from
one place to another.
##### Returns
- This buffer
#### public abstract short
**get**
()
Relative *get* method. Reads the short at this buffer's
current position, and then increments the position.
##### Returns
- The short at the buffer's current position
##### Throws
| [BufferUnderflowException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/BufferUnderflowException.html) | If the buffer's current position is not smaller than its limit |
|---|---|
#### public [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html)
**get**
(short\[\] dst, int offset, int length)
Relative bulk *get* method.
This method transfers shorts from this buffer into the given
destination array. If there are fewer shorts remaining in the
buffer than are required to satisfy the request, that is, if
length \> remaining(), then no
shorts are transferred and a `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/BufferUnderflowException.html` is
thrown.
Otherwise, this method copies length shorts 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 shorts in this buffer and it is potentially much more efficient.
##### Parameters
| dst | The array into which shorts are to be written |
| offset | The offset within the array of the first short to be written; must be non-negative and no larger than dst.length |
| length | The maximum number of shorts to be written to the given array; must be non-negative and no larger than dst.length - offset |
|---|---|
##### Returns
- This buffer
##### Throws
| [BufferUnderflowException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/BufferUnderflowException.html) | If there are fewer than length shorts remaining in this buffer |
| [IndexOutOfBoundsException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IndexOutOfBoundsException.html) | If the preconditions on the offset and length parameters do not hold |
|---|---|
#### public [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html)
**get**
(short\[\] dst)
Relative bulk *get* method.
This method transfers shorts 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)
```
##### Parameters
| dst | The destination array |
|---|---|
##### Returns
- This buffer
##### Throws
| [BufferUnderflowException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/BufferUnderflowException.html) | If there are fewer than length shorts remaining in this buffer |
|---|---|
#### public abstract short
**get**
(int index)
Absolute *get* method. Reads the short at the given
index.
##### Parameters
| index | The index from which the short will be read |
|---|---|
##### Returns
- The short at the given index
##### Throws
| [IndexOutOfBoundsException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IndexOutOfBoundsException.html) | If index is negative or not smaller than the buffer's limit |
|---|---|
#### public final boolean
**hasArray**
()
Tells whether or not this buffer is backed by an accessible short
array.
If this method returns true then the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#array()`
and `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#arrayOffset()` methods may safely be invoked.
##### Returns
- true if, and only if, this buffer is backed by an array and is not read-only
#### public int
**hashCode**
()
Returns the current hash code of this buffer.
The hash code of a short 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.
##### Returns
- The current hash code of this buffer
#### public abstract boolean
**isDirect**
()
Tells whether or not this short buffer is direct.
##### Returns
- true if, and only if, this buffer is direct
#### public [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html)
**limit**
(int newLimit)
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 |
|---|---|
##### Returns
- This buffer
#### public [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html)
**mark**
()
Sets this buffer's mark at its position.
##### Returns
- This buffer
#### public abstract [ByteOrder](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ByteOrder.html)
**order**
()
Retrieves this buffer's byte order.
The byte order of a short buffer created by allocation or by
wrapping an existing short array is the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ByteOrder.html#nativeOrder()` of the underlying
hardware. The byte order of a short buffer created as a [view](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ByteBuffer#views) of a byte buffer is that of the
byte buffer at the moment that the view is created.
##### Returns
- This buffer's byte order
#### public [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html)
**position**
(int newPosition)
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 |
|---|---|
##### Returns
- This buffer
#### public [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html)
**put**
(short\[\] src, int offset, int length)
Relative bulk *put* method *(optional operation)*.
This method transfers shorts into this buffer from the given
source array. If there are more shorts to be copied from the array
than remain in this buffer, that is, if
length \> remaining(), then no
shorts are transferred and a `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/BufferOverflowException.html` is
thrown.
Otherwise, this method copies length shorts 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 shorts are to be read |
| offset | The offset within the array of the first short to be read; must be non-negative and no larger than array.length |
| length | The number of shorts to be read from the given array; must be non-negative and no larger than array.length - offset |
|---|---|
##### Returns
- This buffer
##### Throws
| [BufferOverflowException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/BufferOverflowException.html) | If there is insufficient space in this buffer |
| [IndexOutOfBoundsException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IndexOutOfBoundsException.html) | If the preconditions on the offset and length parameters do not hold |
| [ReadOnlyBufferException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ReadOnlyBufferException.html) | If this buffer is read-only |
|---|---|
#### public final [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html)
**put**
(short\[\] src)
Relative bulk *put* method *(optional operation)*.
This method transfers the entire content of the given source
short 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)
```
##### Parameters
| src | The source array |
|---|---|
##### Returns
- This buffer
##### Throws
| [BufferOverflowException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/BufferOverflowException.html) | If there is insufficient space in this buffer |
| [ReadOnlyBufferException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ReadOnlyBufferException.html) | If this buffer is read-only |
|---|---|
#### public abstract [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html)
**put**
(short s)
Relative *put* method *(optional operation)*.
Writes the given short into this buffer at the current
position, and then increments the position.
##### Parameters
| s | The short to be written |
|---|---|
##### Returns
- This buffer
##### Throws
| [BufferOverflowException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/BufferOverflowException.html) | If this buffer's current position is not smaller than its limit |
| [ReadOnlyBufferException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ReadOnlyBufferException.html) | If this buffer is read-only |
|---|---|
#### public abstract [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html)
**put**
(int index, short s)
Absolute *put* method *(optional operation)*.
Writes the given short into this buffer at the given
index.
##### Parameters
| index | The index at which the short will be written |
| s | The short value to be written |
|---|---|
##### Returns
- This buffer
##### Throws
| [IndexOutOfBoundsException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IndexOutOfBoundsException.html) | If index is negative or not smaller than the buffer's limit |
| [ReadOnlyBufferException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ReadOnlyBufferException.html) | If this buffer is read-only |
|---|---|
#### public [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html)
**put**
([ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html) src)
Relative bulk *put* method *(optional operation)*.
This method transfers the shorts remaining in the given source
buffer into this buffer. If there are more shorts remaining in the
source buffer than in this buffer, that is, if
src.remaining() \> remaining(),
then no shorts are transferred and a `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/BufferOverflowException.html` is thrown.
Otherwise, this method copies
*n* = src.remaining() shorts 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 shorts are to be read; must not be this buffer |
|---|---|
##### Returns
- This buffer
##### Throws
| [BufferOverflowException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/BufferOverflowException.html) | If there is insufficient space in this buffer for the remaining shorts in the source buffer |
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | If the source buffer is this buffer |
| [ReadOnlyBufferException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ReadOnlyBufferException.html) | If this buffer is read-only |
|---|---|
#### public [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html)
**reset**
()
Resets this buffer's position to the previously-marked position.
Invoking this method neither changes nor discards the mark's
value.
##### Returns
- This buffer
#### public [Buffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/Buffer.html)
**rewind**
()
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
> ```
##### Returns
- This buffer
#### public abstract [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html)
**slice**
()
Creates a new short 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 shorts 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 short buffer
#### public [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**toString**
()
Returns a string summarizing the state of this buffer.
##### Returns
- A summary string
#### public static [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html)
**wrap**
(short\[\] array, int offset, int length)
Wraps a short array into a buffer.
The new buffer will be backed by the given short 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
`https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#array()` will be the given array, and
its `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#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 short buffer
##### Throws
| [IndexOutOfBoundsException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IndexOutOfBoundsException.html) | If the preconditions on the offset and length parameters do not hold |
|---|---|
#### public static [ShortBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html)
**wrap**
(short\[\] array)
Wraps a short array into a buffer.
The new buffer will be backed by the given short 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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#array()` will be the
given array, and its `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/ShortBuffer.html#arrayOffset()` will
be zero.
##### Parameters
| array | The array that will back this buffer |
|---|---|
##### Returns
- The new short buffer