tech.bitey.bufferstuff

Enum BufferUtils

java.lang.Object

java.lang.Enum<BufferUtils>

tech.bitey.bufferstuff.BufferUtils

All Implemented Interfaces:

Serializable, Comparable<BufferUtils>

public enum BufferUtils
extends Enum<BufferUtils>

Utility methods for working with nio buffers.

Author:

Lior Privman

Method Summary

Modifier and Type	Method and Description
static ByteBuffer	duplicate(ByteBuffer b) Duplicate a ByteBuffer and preserve the order.
static boolean	isSorted(DoubleBuffer b, int fromIndex, int toIndex) Determines if the specified buffer is sorted inside the specified range.
static boolean	isSorted(FloatBuffer b, int fromIndex, int toIndex) Determines if the specified buffer is sorted inside the specified range.
static boolean	isSorted(IntBuffer b, int fromIndex, int toIndex) Determines if the specified buffer is sorted inside the specified range.
static boolean	isSorted(LongBuffer b, int fromIndex, int toIndex) Determines if the specified buffer is sorted inside the specified range.
static boolean	isSortedAndDistinct(DoubleBuffer b, int fromIndex, int toIndex) Determines if the specified buffer is sorted and distinct inside the specified range.
static boolean	isSortedAndDistinct(FloatBuffer b, int fromIndex, int toIndex) Determines if the specified buffer is sorted and distinct inside the specified range.
static boolean	isSortedAndDistinct(IntBuffer b, int fromIndex, int toIndex) Determines if the specified buffer is sorted and distinct inside the specified range.
static boolean	isSortedAndDistinct(LongBuffer b, int fromIndex, int toIndex) Determines if the specified buffer is sorted and distinct inside the specified range.
static ByteBuffer	slice(ByteBuffer b) Slice a ByteBuffer and preserve the order.
static ByteBuffer	slice(ByteBuffer b, int fromIndex, int toIndex) Slice a range from the specified ByteBuffer.
static BufferUtils	valueOf(String name) Returns the enum constant of this type with the specified name.
static BufferUtils[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static BufferUtils[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BufferUtils c : BufferUtils.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BufferUtils valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

duplicate

public static ByteBuffer duplicate(ByteBuffer b)

Duplicate a ByteBuffer and preserve the order. Equivalent to:

 b.duplicate().order(b.order())
 

Parameters:

b - - the buffer to be duplicated

Returns:

duplicated buffer with order preserved

See Also:

ByteBuffer.duplicate(), ByteBuffer.order()

slice

public static ByteBuffer slice(ByteBuffer b)

Slice a ByteBuffer and preserve the order. Equivalent to:

 b.slice().order(b.order())
 

Parameters:

b - - the buffer to be sliced

Returns:

sliced buffer with order preserved

See Also:

ByteBuffer.slice(), ByteBuffer.order()

slice

public static ByteBuffer slice(ByteBuffer b,
                               int fromIndex,
                               int toIndex)

Slice a range from the specified ByteBuffer. The buffer's order is preserved.

Parameters:

b - - the buffer to be sliced

fromIndex - - the index of the first element in the range (inclusive)

toIndex - - the index of the last element in the range (exclusive)

Returns:

sliced buffer with order preserved

Throws:

IllegalArgumentException - if fromIndex > toIndex

IndexOutOfBoundsException - if fromIndex < 0 or toIndex > b.capacity()

See Also:

ByteBuffer.slice(), ByteBuffer.order()

isSorted

public static boolean isSorted(IntBuffer b,
                               int fromIndex,
                               int toIndex)

Determines if the specified buffer is sorted inside the specified range. That is: buffer[i] <= buffer[i + 1] for all elements in the range. A range of length zero or one is considered sorted.

Parameters:

b - - the buffer to be checked

fromIndex - - the index of the first element (inclusive) to be checked

toIndex - - the index of the last element (exclusive) to be checked

Returns:

true if the buffer is sorted inside the specified range

Throws:

IllegalArgumentException - if fromIndex > toIndex

IndexOutOfBoundsException - if fromIndex < 0 or toIndex > b.capacity()

isSortedAndDistinct

public static boolean isSortedAndDistinct(IntBuffer b,
                                          int fromIndex,
                                          int toIndex)

Determines if the specified buffer is sorted and distinct inside the specified range. That is: buffer[i] < buffer[i + 1] for all elements in the range. A range of length zero or one is considered sorted and distinct.

Parameters:

b - - the buffer to be checked

fromIndex - - the index of the first element (inclusive) to be checked

toIndex - - the index of the last element (exclusive) to be checked

Returns:

true if the buffer is sorted and distinct inside the specified range

Throws:

IllegalArgumentException - if fromIndex > toIndex

IndexOutOfBoundsException - if fromIndex < 0 or toIndex > b.capacity()

isSorted

public static boolean isSorted(LongBuffer b,
                               int fromIndex,
                               int toIndex)

Determines if the specified buffer is sorted inside the specified range. That is: buffer[i] <= buffer[i + 1] for all elements in the range. A range of length zero or one is considered sorted.

Parameters:

b - - the buffer to be checked

fromIndex - - the index of the first element (inclusive) to be checked

toIndex - - the index of the last element (exclusive) to be checked

Returns:

true if the buffer is sorted inside the specified range

Throws:

IllegalArgumentException - if fromIndex > toIndex

IndexOutOfBoundsException - if fromIndex < 0 or toIndex > b.capacity()

isSortedAndDistinct

public static boolean isSortedAndDistinct(LongBuffer b,
                                          int fromIndex,
                                          int toIndex)

Determines if the specified buffer is sorted and distinct inside the specified range. That is: buffer[i] < buffer[i + 1] for all elements in the range. A range of length zero or one is considered sorted and distinct.

Parameters:

b - - the buffer to be checked

fromIndex - - the index of the first element (inclusive) to be checked

toIndex - - the index of the last element (exclusive) to be checked

Returns:

true if the buffer is sorted and distinct inside the specified range

Throws:

IllegalArgumentException - if fromIndex > toIndex

IndexOutOfBoundsException - if fromIndex < 0 or toIndex > b.capacity()

isSorted

public static boolean isSorted(FloatBuffer b,
                               int fromIndex,
                               int toIndex)

Determines if the specified buffer is sorted inside the specified range. That is: buffer[i] <= buffer[i + 1] for all elements in the range. A range of length zero or one is considered sorted. The comparison of two values is consistent with Float.compareTo(Float).

Parameters:

b - - the buffer to be checked

fromIndex - - the index of the first element (inclusive) to be checked

toIndex - - the index of the last element (exclusive) to be checked

Returns:

true if the buffer is sorted inside the specified range

Throws:

IllegalArgumentException - if fromIndex > toIndex

IndexOutOfBoundsException - if fromIndex < 0 or toIndex > b.capacity()

isSortedAndDistinct

public static boolean isSortedAndDistinct(FloatBuffer b,
                                          int fromIndex,
                                          int toIndex)

Determines if the specified buffer is sorted and distinct inside the specified range. That is: buffer[i] < buffer[i + 1] for all elements in the range. A range of length zero or one is considered sorted and distinct. The comparison of two values is consistent with Float.compareTo(Float).

Parameters:

b - - the buffer to be checked

fromIndex - - the index of the first element (inclusive) to be checked

toIndex - - the index of the last element (exclusive) to be checked

Returns:

true if the buffer is sorted and distinct inside the specified range

Throws:

IllegalArgumentException - if fromIndex > toIndex

IndexOutOfBoundsException - if fromIndex < 0 or toIndex > b.capacity()

isSorted

public static boolean isSorted(DoubleBuffer b,
                               int fromIndex,
                               int toIndex)

Determines if the specified buffer is sorted inside the specified range. That is: buffer[i] <= buffer[i + 1] for all elements in the range. A range of length zero or one is considered sorted. The comparison of two values is consistent with Double.compareTo(Double).

Parameters:

b - - the buffer to be checked

fromIndex - - the index of the first element (inclusive) to be checked

toIndex - - the index of the last element (exclusive) to be checked

Returns:

true if the buffer is sorted inside the specified range

Throws:

IllegalArgumentException - if fromIndex > toIndex

IndexOutOfBoundsException - if fromIndex < 0 or toIndex > b.capacity()

isSortedAndDistinct

public static boolean isSortedAndDistinct(DoubleBuffer b,
                                          int fromIndex,
                                          int toIndex)

Determines if the specified buffer is sorted and distinct inside the specified range. That is: buffer[i] < buffer[i + 1] for all elements in the range. A range of length zero or one is considered sorted and distinct. The comparison of two values is consistent with Double.compareTo(Double).

Parameters:

b - - the buffer to be checked

fromIndex - - the index of the first element (inclusive) to be checked

toIndex - - the index of the last element (exclusive) to be checked

Returns:

true if the buffer is sorted and distinct inside the specified range

Throws:

IllegalArgumentException - if fromIndex > toIndex

IndexOutOfBoundsException - if fromIndex < 0 or toIndex > b.capacity()