ej.basictool

Class ArrayTools

java.lang.Object

ej.basictool.ArrayTools

public final class ArrayTools
extends java.lang.Object

Defines a set of functions to manipulate arrays.

Method Summary

Modifier and Type	Method and Description
static int[]	add(int[] array, int element) Adds an element in an array.
static int[]	add(int[] array, int element, int pointer) Adds an element in an array.
static <T> T[]	add(T[] array, T element) Adds an element in an array.
static <T> T[]	add(T[] array, T[] other) Appends an array to another.
static <T> T[]	add(T[] array, T element, int pointer) Adds an element in an array.
static void	checkArrayBounds(int arrayLength, int offset, int length) Checks the given range is included in the array (defined by its length).
static void	checkBounds(byte[] bytes, int offset, int length) Checks the given range is included in the given byte array.
static void	checkBounds(int arrayLength, int offset, int length) Checks the given range is included in the array (defined by its length).
static void	checkStringBounds(int stringLength, int offset, int length) Checks the given range is included in the array (defined by its length).
static <T> boolean	contains(T[] array, T element) Gets whether an array contains an element or not.
static <T> boolean	contains(T[] array, T element, int pointer) Gets whether an array contains an element or not.
static <T> boolean	containsEquals(T[] array, T element) Gets whether an array contains an element or not.
static <T> boolean	containsEquals(T[] array, T element, int pointer) Gets whether an array contains an element or not.
static int[]	copy(int[] array) Copies an array.
static int[]	copy(int[] array, int pointer) Copy the (ptr + 1) elements of an array.
static <T> T[]	copy(java.lang.Object[] array, java.lang.Class<T[]> type) Copies an array into an array of a different type.
static <T> T[]	copy(java.lang.Object[] array, int pointer, java.lang.Class<T[]> type) Allocates a new array of the given type, and then copy the first (pointer + 1) elements of an array.
static <T> T[]	copy(T[] array) Copies an array.
static <T> T[]	copy(T[] array, int pointer) Allocates a new array of the same type than the given array, and then copy the first (pointer + 1) elements of an array.
static <T> T[]	createNewArray(java.lang.Class<T[]> type, int length) Creates a new array from the given type and length.
static <T> T[]	createNewArray(T[] array, int length) Creates a new array with the same type as the given array.
static <T> int	getIndex(T[] array, T element) Gets the index of an element in an array.
static <T> int	getIndex(T[] array, T element, int pointer) Gets the index of an element in an array.
static <T> int	getIndexEquals(T[] array, T element) Gets the index of an element in an array.
static <T> int	getIndexEquals(T[] array, T element, int pointer) Gets the index of an element in an array.
static <T> T[]	insert(T[] array, int index, T element) Inserts an element at an index in an array.
static <T> T[]	insert(T[] array, int index, T element, int pointer) Inserts an element at an index in an array.
static int[]	remove(int[] array, int element) Removes an element in an array.
static boolean	remove(int[] array, int element, int pointer) Removes an element in an array.
static <T> T[]	remove(T[] array, int index) Removes an element at an index in an array.
static <T> T[]	remove(T[] array, T element) Removes an element in an array.
static <T> boolean	remove(T[] array, T element, int pointer) Removes an element in an array.
static <T> T[]	removeEquals(T[] array, T element) Removes an element in an array.
static <T> boolean	removeEquals(T[] array, T element, int pointer) Removes an element in an array.
static int[]	removeRange(int[] array, int offset, int length) Removes several elements in an array.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

checkBounds

public static void checkBounds(byte[] bytes,
                               int offset,
                               int length)

Checks the given range is included in the given byte array.

Parameters:

bytes - the byte array.

offset - the offset of the range.

length - the length of the range.

Throws:

java.lang.NullPointerException - if bytes is null.

java.lang.IndexOutOfBoundsException - if the range is not included in the array.

checkBounds

public static void checkBounds(int arrayLength,
                               int offset,
                               int length)

Checks the given range is included in the array (defined by its length).

Parameters:

arrayLength - the array length.

offset - the offset of the range.

length - the length of the range.

Throws:

java.lang.IndexOutOfBoundsException - if the range is not included in the array.

checkArrayBounds

public static void checkArrayBounds(int arrayLength,
                                    int offset,
                                    int length)

Checks the given range is included in the array (defined by its length).

Parameters:

arrayLength - the array length.

offset - the offset of the range.

length - the length of the range.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the range is not included in the array.

checkStringBounds

public static void checkStringBounds(int stringLength,
                                     int offset,
                                     int length)

Checks the given range is included in the array (defined by its length).

Parameters:

stringLength - the string length.

offset - the offset of the range.

length - the length of the range.

Throws:

java.lang.StringIndexOutOfBoundsException - if the range is not included in the array.

add

public static <T> T[] add(T[] array,
                          T element)

Adds an element in an array. The array returned is always different from the given one, and its size fit the number of elements (in opposition with add(Object[], Object, int)).

Type Parameters:

T - the type of array elements.

Parameters:

array - the input array.

element - the element to add.

Returns:

the output array.

Throws:

java.lang.NullPointerException - if the given array is null.

add

public static <T> T[] add(T[] array,
                          T[] other)

Appends an array to another. The array returned is always different from the given one, and its size fit the number of elements (in opposition with add(Object[], Object, int)).

Type Parameters:

T - the type of array elements.

Parameters:

array - the input array.

other - the array to append.

Returns:

the output array.

Throws:

java.lang.NullPointerException - if one of the given array is null.

insert

public static <T> T[] insert(T[] array,
                             int index,
                             T element)

Inserts an element at an index in an array. The array returned is always different from the given one, and its size fit the number of elements (in opposition with insert(Object[], int, Object, int)).

Type Parameters:

T - the type of array elements.

Parameters:

array - the input array.

index - the index in the array.

element - the element to add.

Returns:

the output array.

Throws:

java.lang.NullPointerException - if the given array is null.

java.lang.IndexOutOfBoundsException - if the given index is not included in the resulting array.

remove

public static <T> T[] remove(T[] array,
                             T element)

Removes an element in an array.

The comparison between the elements is done using == operator.

If the array does not contain the given element, the returned array is the given one, otherwise, it is always a different one. If the array contains several times the given element, only the last added is removed.

The returned array size fit the number of elements (in opposition with remove(Object[], Object, int)).

Type Parameters:

T - the type of array elements.

Parameters:

array - the input array.

element - the element to remove.

Returns:

the output array.

Throws:

java.lang.NullPointerException - if the given array is null.

removeEquals

public static <T> T[] removeEquals(T[] array,
                                   T element)

Removes an element in an array.

The comparison between the elements is done using Object.equals(Object).

If the array does not contain the given element, the returned array is the given one, otherwise, it is always a different one. If the array contains several times the given element, only the last added is removed.

The returned array size fit the number of elements (in opposition with remove(Object[], Object, int)).

Type Parameters:

T - the type of array elements.

Parameters:

array - the input array.

element - the element to remove.

Returns:

the output array.

Throws:

java.lang.NullPointerException - if the given array is null.

remove

public static <T> T[] remove(T[] array,
                             int index)

Removes an element at an index in an array.

The returned array size fit the number of elements.

Type Parameters:

T - the type of array elements.

Parameters:

array - the input array.

index - the index of the element to remove.

Returns:

the output array.

Throws:

java.lang.NullPointerException - if the given array is null.

java.lang.IndexOutOfBoundsException - if the given index is not included in the resulting array.

contains

public static <T> boolean contains(T[] array,
                                   T element)

Gets whether an array contains an element or not.

The comparison between the elements is done using == operator.

Type Parameters:

T - the type of array elements.

Parameters:

array - the array.

element - the element to search.

Returns:

true if the element exists in the array, false otherwise.

Throws:

java.lang.NullPointerException - if the given array is null.

containsEquals

public static <T> boolean containsEquals(T[] array,
                                         T element)

Gets whether an array contains an element or not.

The comparison between the elements is done using Object.equals(Object).

Type Parameters:

T - the type of array elements.

Parameters:

array - the array.

element - the element to search.

Returns:

true if the element exists in the array, false otherwise.

Throws:

java.lang.NullPointerException - if the given array is null.

getIndex

public static <T> int getIndex(T[] array,
                               T element)

Gets the index of an element in an array.

The comparison between the elements is done using == operator.

Type Parameters:

T - the type of array elements.

Parameters:

array - the array.

element - the element to search.

Returns:

the index of the element in the array or -1 if not found.

Throws:

java.lang.NullPointerException - if the given array is null.

getIndexEquals

public static <T> int getIndexEquals(T[] array,
                                     T element)

Gets the index of an element in an array.

The comparison between the elements is done using Object.equals(Object).

Type Parameters:

T - the type of array elements.

Parameters:

array - the array.

element - the element to search.

Returns:

the index of the element in the array or -1 if not found.

Throws:

java.lang.NullPointerException - if the given array is null.

copy

public static <T> T[] copy(T[] array)

Copies an array.

Type Parameters:

T - the type of array elements.

Parameters:

array - the input array.

Returns:

the output array.

Throws:

java.lang.NullPointerException - if the given array is null.

copy

public static <T> T[] copy(java.lang.Object[] array,
                           java.lang.Class<T[]> type)

Copies an array into an array of a different type.

Type Parameters:

T - the type of array elements.

Parameters:

array - the input array.

type - the output array type.

Returns:

the output array.

Throws:

java.lang.NullPointerException - if the given type is null.

java.lang.ArrayStoreException - if the given type is not an array type.

java.lang.ArrayStoreException - if the given type mismatch the array elements type.

add

public static int[] add(int[] array,
                        int element)

Adds an element in an array. The array returned is always different from the given one, and its size fit the number of elements (in opposition with add(int[], int, int)).

Parameters:

array - the input array.

element - the element to add.

Returns:

the output array.

Throws:

java.lang.NullPointerException - if the given array is null.

remove

public static int[] remove(int[] array,
                           int element)

Removes an element in an array.

If the array does not contain the given element, the returned array is the given array, otherwise, it is always a different one. If the array contains several times the given element, only the last added is removed.

The returned array size fit the number of elements (in opposition with remove(int[], int, int)).

Parameters:

array - the input array.

element - the element to remove.

Returns:

the output array.

Throws:

java.lang.NullPointerException - if the given array is null.

removeRange

public static int[] removeRange(int[] array,
                                int offset,
                                int length)

Removes several elements in an array.

The returned array size fit the number of elements.

Parameters:

array - the input array.

offset - the start index of the range to remove.

length - the number of elements to remove.

Returns:

the output array.

Throws:

java.lang.NullPointerException - if the given array is null.

copy

public static int[] copy(int[] array)

Copies an array.

Parameters:

array - the input array.

Returns:

the output array.

Throws:

java.lang.NullPointerException - if the given array is null.

add

public static <T> T[] add(T[] array,
                          T element,
                          int pointer)

Adds an element in an array.

The array returned could be different from the given one, it grows to pointer*2 only if the given array is not large enough to add the given element (pointer == array.length).

Type Parameters:

T - the type of array elements.

Parameters:

array - the input array.

element - the element to add.

pointer - the index of the element to add.

Returns:

the output array.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the given pointer is greater than the array length.

java.lang.NullPointerException - if the given array is null.

insert

public static <T> T[] insert(T[] array,
                             int index,
                             T element,
                             int pointer)

Inserts an element at an index in an array.

The array returned could be different from the given one, it grows to pointer*2 only if the given array is not large enough to add the given element (pointer == array.length).

Type Parameters:

T - the type of array elements.

Parameters:

array - the input array.

index - the index in the array.

element - the element to add.

pointer - the index of the element to add.

Returns:

the output array.

Throws:

java.lang.NullPointerException - if the given array is null.

java.lang.ArrayIndexOutOfBoundsException - if the given pointer is greater than the array length.

java.lang.IndexOutOfBoundsException - if the given index is not included in the resulting array.

remove

public static <T> boolean remove(T[] array,
                                 T element,
                                 int pointer)

Removes an element in an array.

The comparison between the elements is done using == operator.

If the array does not contain the given element, the given array is not modified and the method returns false, otherwise it returns true.

If the array contains several times the given element, only the last added is removed.

Type Parameters:

T - the type of array elements.

Parameters:

array - the input array.

element - the element to remove.

pointer - the index of the last element of the array.

Returns:

true if the element has been removed, false otherwise.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the given pointer is greater than the array length.

java.lang.NullPointerException - if the given array is null.

removeEquals

public static <T> boolean removeEquals(T[] array,
                                       T element,
                                       int pointer)

Removes an element in an array.

The comparison between the elements is done using Object.equals(Object).

If the array does not contain the given element, the given array is not modified and the method returns false, otherwise it returns true.

If the array contains several times the given element, only the last added is removed.

Type Parameters:

T - the type of array elements.

Parameters:

array - the input array.

element - the element to remove.

pointer - the index of the last element of the array.

Returns:

true if the element has been removed, false otherwise.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the given pointer is greater than the array length.

java.lang.NullPointerException - if the given array is null.

contains

public static <T> boolean contains(T[] array,
                                   T element,
                                   int pointer)

Gets whether an array contains an element or not.

The comparison between the elements is done using == operator.

Type Parameters:

T - the type of array elements.

Parameters:

array - the array.

element - the element to search.

pointer - the index of the last element of the array.

Returns:

true if the element exists in the array, false otherwise.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the given pointer is greater than the array length.

java.lang.NullPointerException - if the given array is null.

containsEquals

public static <T> boolean containsEquals(T[] array,
                                         T element,
                                         int pointer)

Gets whether an array contains an element or not.

The comparison between the elements is done using Object.equals(Object).

Type Parameters:

T - the type of array elements.

Parameters:

array - the array.

element - the element to search.

pointer - the index of the last element of the array.

Returns:

true if the element exists in the array, false otherwise.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the given pointer is greater than the array length.

java.lang.NullPointerException - if the given array is null.

getIndex

public static <T> int getIndex(T[] array,
                               T element,
                               int pointer)

Gets the index of an element in an array.

The comparison between the elements is done using == operator.

Type Parameters:

T - the type of array elements.

Parameters:

array - the array.

element - the element to search.

pointer - the index of the last element of the array.

Returns:

the index of the element in the array or -1 if not found.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the given pointer is greater than the array length.

java.lang.NullPointerException - if the given array is null.

getIndexEquals

public static <T> int getIndexEquals(T[] array,
                                     T element,
                                     int pointer)

Gets the index of an element in an array.

The comparison between the elements is done using Object.equals(Object).

Type Parameters:

T - the type of array elements.

Parameters:

array - the array.

element - the element to search.

pointer - the index of the last element of the array.

Returns:

the index of the element in the array or -1 if not found.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the given pointer is greater than the array length.

java.lang.NullPointerException - if the given array is null.

copy

public static <T> T[] copy(T[] array,
                           int pointer)

Allocates a new array of the same type than the given array, and then copy the first (pointer + 1) elements of an array.

Type Parameters:

T - the type of array elements.

Parameters:

array - the input array.

pointer - the index of the last element of the array.

Returns:

a new allocated array filled with the content of the input array range [0,pointer].

Throws:

java.lang.NullPointerException - if the given array is null.

copy

public static <T> T[] copy(java.lang.Object[] array,
                           int pointer,
                           java.lang.Class<T[]> type)

Allocates a new array of the given type, and then copy the first (pointer + 1) elements of an array.

Type Parameters:

T - the type of array elements.

Parameters:

array - the input array

pointer - the index of the last element of the array

type - the output array type

Returns:

a new allocated array filled with the content of the input array range [0,pointer].

Throws:

java.lang.NullPointerException - if the given type is null

java.lang.ArrayStoreException - if the given type is not an array type

java.lang.ArrayStoreException - if the given type mismatch the array elements type

add

public static int[] add(int[] array,
                        int element,
                        int pointer)

Adds an element in an array.

The array returned could be different from the given one, it grows to pointer*2 only if the given array is not large enough to add the given element (ptr == array.length).

Parameters:

array - the input array.

element - the element to add.

pointer - the index of the element to add.

Returns:

the output array.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the pointer is greater than the array length.

java.lang.NullPointerException - if the given array is null.

remove

public static boolean remove(int[] array,
                             int element,
                             int pointer)

Removes an element in an array.

If the array does not contain the given element, the given array is not modified and the method returns false, otherwise it returns true.

If the array contains several times the given element, only the last added is removed.

Parameters:

array - the input array.

element - the element to remove.

pointer - the index of the last element of the array.

Returns:

true if the element has been removed, false otherwise.

Throws:

java.lang.NullPointerException - if the given array is null.

copy

public static int[] copy(int[] array,
                         int pointer)

Copy the (ptr + 1) elements of an array.

Parameters:

array - the input array.

pointer - the index of the last element of the array.

Returns:

the output array.

Throws:

java.lang.NullPointerException - if the given array is null.

createNewArray

public static <T> T[] createNewArray(T[] array,
                                     int length)

Creates a new array with the same type as the given array.

Type Parameters:

T - the type of array elements.

Parameters:

array - the array.

length - the length of the array to create.

Returns:

the created array as an object

createNewArray

public static <T> T[] createNewArray(java.lang.Class<T[]> type,
                                     int length)

Creates a new array from the given type and length.

Type Parameters:

T - the type of array elements.

Parameters:

type - the type of the array to create.

length - the length of the array to create.

Returns:

the created array as an object.