Android APIs
public abstract class

LongBuffer

extends Buffer
implements Comparable<LongBuffer>
java.lang.Object
   ↳ java.nio.Buffer
     ↳ java.nio.LongBuffer

Class Overview

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.

Summary

Public Methods
static LongBuffer allocate(int capacity)
Creates a long buffer based on a newly allocated long array.
final long[] array()
Returns the array that backs this buffer (optional operation).
final int arrayOffset()
Returns the offset into the array returned by array of the first element of the buffer (optional operation).
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(int index)
Returns the long at the specified index; the position is not changed.
LongBuffer get(long[] dst)
Reads longs from the current position into the specified long array and increases the position by the number of longs read.
LongBuffer get(long[] dst, int dstOffset, int longCount)
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.
abstract long get()
Returns the long at the current position and increase the position by 1.
final boolean hasArray()
Returns true if array and arrayOffset won't throw.
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.
LongBuffer put(long[] src, int srcOffset, int longCount)
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.
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.
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 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.
abstract LongBuffer slice()
Returns a sliced buffer that shares its content with this buffer.
static LongBuffer wrap(long[] array, int start, int longCount)
Creates a new long buffer by wrapping the given long array.
static LongBuffer wrap(long[] array)
Creates a new long buffer by wrapping the given long array.
[Expand]
Inherited Methods
From class java.nio.Buffer
From class java.lang.Object
From interface java.lang.Comparable

Public Methods

public static LongBuffer allocate (int capacity)

Added in API level 1

Creates a long buffer based on a newly allocated long array.

Parameters
capacity int: the capacity of the new buffer.
Returns
LongBuffer the created long buffer.
Throws
IllegalArgumentException if capacity is less than zero.

public final long[] array ()

Added in API level 1

Returns the array that backs this buffer (optional operation). The returned value is the actual array, not a copy, so modifications to the array write through to the buffer.

Subclasses should override this method with a covariant return type to provide the exact type of the array.

Use hasArray to ensure this method won't throw. (A separate call to isReadOnly is not necessary.)

Returns
long[] the array

public final int arrayOffset ()

Added in API level 1

Returns the offset into the array returned by array of the first element of the buffer (optional operation). The backing array (if there is one) is not necessarily the same size as the buffer, and position 0 in the buffer is not necessarily the 0th element in the array. Use buffer.array()[offset + buffer.arrayOffset() to access element offset in buffer.

Use hasArray to ensure this method won't throw. (A separate call to isReadOnly is not necessary.)

Returns
int the offset

public abstract LongBuffer asReadOnlyBuffer ()

Added in API level 1

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
LongBuffer a read-only version of this buffer.

public abstract LongBuffer compact ()

Added in API level 1

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
LongBuffer this buffer.
Throws
ReadOnlyBufferException if no changes may be made to the contents of this buffer.

public int compareTo (LongBuffer otherBuffer)

Added in API level 1

Compare the remaining longs of this buffer to another long buffer's remaining longs.

Parameters
otherBuffer LongBuffer: another long buffer.
Returns
int 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.

public abstract LongBuffer duplicate ()

Added in API level 1

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 buffers' position, limit and mark are independent.

Returns
LongBuffer

public boolean equals (Object other)

Added in API level 1

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.

Parameters
other Object: the object to compare with this long buffer.
Returns
boolean true if this long buffer is equal to other, false otherwise.

public abstract long get (int index)

Added in API level 1

Returns the long at the specified index; the position is not changed.

Parameters
index int: the index, must not be negative and less than limit.
Returns
long the long at the specified index.
Throws
IndexOutOfBoundsException if index is invalid.

public LongBuffer get (long[] dst)

Added in API level 1

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(dst, 0, dst.length).

Parameters
dst long: the destination long array.
Returns
LongBuffer this buffer.
Throws
BufferUnderflowException if dst.length is greater than remaining().

public LongBuffer get (long[] dst, int dstOffset, int longCount)

Added in API level 1

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
dst long: the target long array.
dstOffset int: the offset of the long array, must not be negative and not greater than dst.length.
longCount int: the number of longs to read, must be no less than zero and not greater than dst.length - dstOffset.
Returns
LongBuffer this buffer.
Throws
IndexOutOfBoundsException if either dstOffset or longCount is invalid.
BufferUnderflowException if longCount is greater than remaining().

public abstract long get ()

Added in API level 1

Returns the long at the current position and increase the position by 1.

Returns
long the long at the current position.
Throws
BufferUnderflowException if the position is equal or greater than limit.

public final boolean hasArray ()

Added in API level 1

Returns true if array and arrayOffset won't throw. This method does not return true for buffers not backed by arrays because the other methods would throw UnsupportedOperationException, nor does it return true for buffers backed by read-only arrays, because the other methods would throw ReadOnlyBufferException.

Returns
boolean

public int hashCode ()

Added in API level 1

Calculates this buffer's hash code from the remaining chars. The position, limit, capacity and mark don't affect the hash code.

Returns
int the hash code calculated from the remaining longs.

public abstract boolean isDirect ()

Added in API level 1

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
boolean true if this buffer is direct, false otherwise.

public abstract ByteOrder order ()

Added in API level 1

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
ByteOrder the byte order used by this buffer when converting longs from/to bytes.

public LongBuffer put (long[] src, int srcOffset, int longCount)

Added in API level 1

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 long: the source long array.
srcOffset int: the offset of long array, must not be negative and not greater than src.length.
longCount int: the number of longs to write, must be no less than zero and not greater than src.length - srcOffset.
Returns
LongBuffer this buffer.
Throws
BufferOverflowException if remaining() is less than longCount.
IndexOutOfBoundsException if either srcOffset or longCount is invalid.
ReadOnlyBufferException if no changes may be made to the contents of this buffer.

public final LongBuffer put (long[] src)

Added in API level 1

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 long: the source long array.
Returns
LongBuffer this buffer.
Throws
BufferOverflowException if remaining() is less than src.length.
ReadOnlyBufferException if no changes may be made to the contents of this buffer.

public LongBuffer put (LongBuffer src)

Added in API level 1

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 LongBuffer: the source long buffer.
Returns
LongBuffer 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.

public abstract LongBuffer put (int index, long l)

Added in API level 1

Writes a long to the specified index of this buffer; the position is not changed.

Parameters
index int: the index, must not be negative and less than the limit.
l long: the long to write.
Returns
LongBuffer this buffer.
Throws
IndexOutOfBoundsException if index is invalid.
ReadOnlyBufferException if no changes may be made to the contents of this buffer.

public abstract LongBuffer put (long l)

Added in API level 1

Writes the given long to the current position and increases the position by 1.

Parameters
l long: the long to write.
Returns
LongBuffer 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.

public abstract LongBuffer slice ()

Added in API level 1

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 buffers' position, limit and mark are independent.

Returns
LongBuffer

public static LongBuffer wrap (long[] array, int start, int longCount)

Added in API level 1

Creates a new long buffer by wrapping the given long array.

The new buffer's position will be start, limit will be start + longCount, capacity will be the length of the array.

Parameters
array long: the long array which the new buffer will be based on.
start int: the start index, must not be negative and not greater than array.length.
longCount int: the length, must not be negative and not greater than array.length - start.
Returns
LongBuffer the created long buffer.
Throws
IndexOutOfBoundsException if either start or longCount is invalid.

public static LongBuffer wrap (long[] array)

Added in API level 1

Creates a new long buffer by wrapping the given long array.

Calling this method has the same effect as wrap(array, 0, array.length).

Parameters
array long: the long array which the new buffer will be based on.
Returns
LongBuffer the created long buffer.