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:

biteytech@protonmail.com

Field Summary

Fields

Modifier and Type	Field and Description
static ByteBuffer	EMPTY_BUFFER An empty, read-only ByteBuffer which has native order

Method Summary

Modifier and Type	Method and Description
static ByteBuffer	allocate(int capacity) Allocates a new ByteBuffer with the specified capacity.
static ByteBuffer	allocate(int capacity, ByteOrder order) Allocates a new ByteBuffer with the specified capacity.
static ByteBuffer	asReadOnlyBuffer(ByteBuffer b) Creates a new, read-only byte buffer that shares the specified buffer's content, and preserves it's order.
static ByteBuffer	copy(ByteBuffer b, int fromIndex, int toIndex) Returns a copy of a range from the specified buffer.
static DoubleBuffer	copy(DoubleBuffer b, int fromIndex, int toIndex) Returns a copy of a range from the specified buffer.
static FloatBuffer	copy(FloatBuffer b, int fromIndex, int toIndex) Returns a copy of a range from the specified buffer.
static IntBuffer	copy(IntBuffer b, int fromIndex, int toIndex) Returns a copy of a range from the specified buffer.
static LongBuffer	copy(LongBuffer b, int fromIndex, int toIndex) Returns a copy of a range from the specified buffer.
static ShortBuffer	copy(ShortBuffer b, int fromIndex, int toIndex) Returns a copy of a range from the specified buffer.
static int	deduplicate(ByteBuffer b, int fromIndex, int toIndex) Deduplicates a range of the specified ByteBuffer.
static int	deduplicate(DoubleBuffer b, int fromIndex, int toIndex) Deduplicates a range of the specified DoubleBuffer.
static int	deduplicate(FloatBuffer b, int fromIndex, int toIndex) Deduplicates a range of the specified FloatBuffer.
static int	deduplicate(IntBuffer b, int fromIndex, int toIndex) Deduplicates a range of the specified IntBuffer.
static int	deduplicate(LongBuffer b, int fromIndex, int toIndex) Deduplicates a range of the specified LongBuffer.
static int	deduplicate(ShortBuffer b, int fromIndex, int toIndex) Deduplicates a range of the specified ShortBuffer.
static ByteBuffer	duplicate(ByteBuffer b) Duplicate a ByteBuffer and preserve the order.
static boolean	isSorted(ByteBuffer b, int fromIndex, int toIndex) Determines if the specified buffer is sorted inside the specified range.
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	isSorted(ShortBuffer b, int fromIndex, int toIndex) Determines if the specified buffer is sorted inside the specified range.
static boolean	isSortedAndDistinct(ByteBuffer b, int fromIndex, int toIndex) Determines if the specified buffer is sorted and distinct 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 boolean	isSortedAndDistinct(ShortBuffer 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

Field Detail

EMPTY_BUFFER

public static final ByteBuffer EMPTY_BUFFER

An empty, read-only ByteBuffer which has native order

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

allocate

public static ByteBuffer allocate(int capacity)

Allocates a new ByteBuffer with the specified capacity. The buffer will be direct if the tech.bitey.allocateDirect system property is set to "true", and will have native order.

Parameters:

capacity - the new buffer's capacity, in bytes

Returns:

the new native order ByteBuffer

allocate

public static ByteBuffer allocate(int capacity,
                                  ByteOrder order)

Allocates a new ByteBuffer with the specified capacity. The buffer will be direct if the tech.bitey.allocateDirect system property is set to "true", and will have the specified ByteOrder.

Parameters:

capacity - the new buffer's capacity, in bytes

order - the ByteOrder

Returns:

the new ByteBuffer

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()

asReadOnlyBuffer

public static ByteBuffer asReadOnlyBuffer(ByteBuffer b)

Creates a new, read-only byte buffer that shares the specified buffer's content, and preserves it's order. Equivalent to:

 b.asReadOnlyBuffer().order(b.order())
 

Parameters:

b - - the buffer to be made read-only

Returns:

read-only byte buffer that shares the specified buffer's content

See Also:

ByteBuffer.asReadOnlyBuffer(), 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(ByteBuffer 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(ByteBuffer 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(ShortBuffer 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(ShortBuffer 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()

copy

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

Returns a copy of a range from the specified buffer. The new buffer will be direct iff the specified buffer is direct, and will have the same byte order. The capacity will be equal to the size of the specified range. The limit will be set to the capacity, and the position will be set to zero.

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:

a copy of a range of data from the specified buffer

Throws:

IllegalArgumentException - if fromIndex > toIndex

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

copy

public static IntBuffer copy(IntBuffer b,
                             int fromIndex,
                             int toIndex)

Returns a copy of a range from the specified buffer. The new buffer will be direct iff the specified buffer is direct, and will have the same byte order. The capacity will be equal to the size of the specified range. The limit will be set to the capacity, and the position will be set to zero.

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:

a copy of a range of data from the specified buffer

Throws:

IllegalArgumentException - if fromIndex > toIndex

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

copy

public static LongBuffer copy(LongBuffer b,
                              int fromIndex,
                              int toIndex)

Returns a copy of a range from the specified buffer. The new buffer will be direct iff the specified buffer is direct, and will have the same byte order. The capacity will be equal to the size of the specified range. The limit will be set to the capacity, and the position will be set to zero.

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:

a copy of a range of data from the specified buffer

Throws:

IllegalArgumentException - if fromIndex > toIndex

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

copy

public static ShortBuffer copy(ShortBuffer b,
                               int fromIndex,
                               int toIndex)

Returns a copy of a range from the specified buffer. The new buffer will be direct iff the specified buffer is direct, and will have the same byte order. The capacity will be equal to the size of the specified range. The limit will be set to the capacity, and the position will be set to zero.

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:

a copy of a range of data from the specified buffer

Throws:

IllegalArgumentException - if fromIndex > toIndex

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

copy

public static FloatBuffer copy(FloatBuffer b,
                               int fromIndex,
                               int toIndex)

Returns a copy of a range from the specified buffer. The new buffer will be direct iff the specified buffer is direct, and will have the same byte order. The capacity will be equal to the size of the specified range. The limit will be set to the capacity, and the position will be set to zero.

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:

a copy of a range of data from the specified buffer

Throws:

IllegalArgumentException - if fromIndex > toIndex

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

copy

public static DoubleBuffer copy(DoubleBuffer b,
                                int fromIndex,
                                int toIndex)

Returns a copy of a range from the specified buffer. The new buffer will be direct iff the specified buffer is direct, and will have the same byte order. The capacity will be equal to the size of the specified range. The limit will be set to the capacity, and the position will be set to zero.

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:

a copy of a range of data from the specified buffer

Throws:

IllegalArgumentException - if fromIndex > toIndex

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

deduplicate

public static int deduplicate(IntBuffer b,
                              int fromIndex,
                              int toIndex)

Deduplicates a range of the specified IntBuffer. The range must be sorted in ascending order prior to making this call. If it is not sorted, the results are undefined.

This method is useful as a post-processing step after a sort on a buffer which contains duplicate elements.

Parameters:

b - the buffer to be deduplicated

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

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

Returns:

the (exclusive) highest index in use after deduplicating

Throws:

IllegalArgumentException - if fromIndex > toIndex

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

deduplicate

public static int deduplicate(LongBuffer b,
                              int fromIndex,
                              int toIndex)

Deduplicates a range of the specified LongBuffer. The range must be sorted in ascending order prior to making this call. If it is not sorted, the results are undefined.

This method is useful as a post-processing step after a sort on a buffer which contains duplicate elements.

Parameters:

b - the buffer to be deduplicated

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

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

Returns:

the (exclusive) highest index in use after deduplicating

Throws:

IllegalArgumentException - if fromIndex > toIndex

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

deduplicate

public static int deduplicate(ShortBuffer b,
                              int fromIndex,
                              int toIndex)

Deduplicates a range of the specified ShortBuffer. The range must be sorted in ascending order prior to making this call. If it is not sorted, the results are undefined.

This method is useful as a post-processing step after a sort on a buffer which contains duplicate elements.

Parameters:

b - the buffer to be deduplicated

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

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

Returns:

the (exclusive) highest index in use after deduplicating

Throws:

IllegalArgumentException - if fromIndex > toIndex

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

deduplicate

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

Deduplicates a range of the specified ByteBuffer. The range must be sorted in ascending order prior to making this call. If it is not sorted, the results are undefined.

This method is useful as a post-processing step after a sort on a buffer which contains duplicate elements.

Parameters:

b - the buffer to be deduplicated

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

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

Returns:

the (exclusive) highest index in use after deduplicating

Throws:

IllegalArgumentException - if fromIndex > toIndex

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

deduplicate

public static int deduplicate(FloatBuffer b,
                              int fromIndex,
                              int toIndex)

Deduplicates a range of the specified FloatBuffer. The range must be sorted in ascending order prior to making this call. If it is not sorted, the results are undefined. This method considers all NaN values to be equivalent and equal.

This method is useful as a post-processing step after a sort on a buffer which contains duplicate elements.

Parameters:

b - the buffer to be deduplicated

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

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

Returns:

the (exclusive) highest index in use after deduplicating

Throws:

IllegalArgumentException - if fromIndex > toIndex

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

deduplicate

public static int deduplicate(DoubleBuffer b,
                              int fromIndex,
                              int toIndex)

Deduplicates a range of the specified DoubleBuffer. The range must be sorted in ascending order prior to making this call. If it is not sorted, the results are undefined. This method considers all NaN values to be equivalent and equal.

This method is useful as a post-processing step after a sort on a buffer which contains duplicate elements.

Parameters:

b - the buffer to be deduplicated

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

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

Returns:

the (exclusive) highest index in use after deduplicating

Throws:

IllegalArgumentException - if fromIndex > toIndex

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