ByteBuffer.Get Method

Definition

Namespace:

Java.Nio

Assembly:

Mono.Android.dll

Overloads

Get()	Relative get method.
Get(Byte[])	Relative bulk get method.
Get(Int32)	Absolute get method.
Get(Byte[], Int32, Int32)	Relative bulk get method.

Get()

Relative get method.

[Android.Runtime.Register("get", "()B", "GetGetHandler")]
public abstract sbyte Get ();

[<Android.Runtime.Register("get", "()B", "GetGetHandler")>]
abstract member Get : unit -> sbyte

Returns

SByte

The byte at the buffer's current position

Attributes

RegisterAttribute

Exceptions

BufferUnderflowException

if the position is equal or greater than limit.

Remarks

Relative get method. Reads the byte at this buffer's current position, and then increments the position.

Java documentation for java.nio.ByteBuffer.get().

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Get(Byte[])

Relative bulk get method.

[Android.Runtime.Register("get", "([B)Ljava/nio/ByteBuffer;", "GetGet_arrayBHandler")]
public virtual Java.Nio.ByteBuffer Get (byte[] dst);

[<Android.Runtime.Register("get", "([B)Ljava/nio/ByteBuffer;", "GetGet_arrayBHandler")>]
abstract member Get : byte[] -> Java.Nio.ByteBuffer
override this.Get : byte[] -> Java.Nio.ByteBuffer

Parameters

dst

Byte[]

The destination array

Returns

ByteBuffer

This buffer

Attributes

RegisterAttribute

Exceptions

BufferUnderflowException

if dst.length is greater than remaining().

Remarks

Relative bulk get method.

This method transfers bytes 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)

Java documentation for java.nio.ByteBuffer.get(byte[]).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Get(Int32)

Absolute get method.

[Android.Runtime.Register("get", "(I)B", "GetGet_IHandler")]
public abstract sbyte Get (int index);

[<Android.Runtime.Register("get", "(I)B", "GetGet_IHandler")>]
abstract member Get : int -> sbyte

Parameters

index

Int32

The index from which the byte will be read

Returns

SByte

The byte at the given index

Attributes

RegisterAttribute

Exceptions

IndexOutOfBoundsException

if index is invalid.

Remarks

Absolute get method. Reads the byte at the given index.

Java documentation for java.nio.ByteBuffer.get(int).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Get(Byte[], Int32, Int32)

Relative bulk get method.

[Android.Runtime.Register("get", "([BII)Ljava/nio/ByteBuffer;", "GetGet_arrayBIIHandler")]
public virtual Java.Nio.ByteBuffer Get (byte[] dst, int offset, int length);

[<Android.Runtime.Register("get", "([BII)Ljava/nio/ByteBuffer;", "GetGet_arrayBIIHandler")>]
abstract member Get : byte[] * int * int -> Java.Nio.ByteBuffer
override this.Get : byte[] * int * int -> Java.Nio.ByteBuffer

Parameters

dst

Byte[]

The array into which bytes are to be written

offset

Int32

The offset within the array of the first byte to be written; must be non-negative and no larger than dst.length

length

Int32

The maximum number of bytes to be written to the given array; must be non-negative and no larger than dst.length - offset

Returns

ByteBuffer

This buffer

Attributes

RegisterAttribute

Exceptions

IndexOutOfBoundsException

if dstOffset

BufferUnderflowException

if byteCount > remaining()

Remarks

Relative bulk get method.

This method transfers bytes from this buffer into the given destination array. If there are fewer bytes remaining in the buffer than are required to satisfy the request, that is, if length > remaining(), then no bytes are transferred and a BufferUnderflowException is thrown.

Otherwise, this method copies length bytes 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

{@code
                for (int i = off; i < off + len; i++)
                    dst[i] = src.get();
            }

except that it first checks that there are sufficient bytes in this buffer and it is potentially much more efficient.

Java documentation for java.nio.ByteBuffer.get(byte[], int, int).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.