net.lenni0451.commons.arrays.wrapper

Class ArrayWrapper<T>

java.lang.Object

net.lenni0451.commons.arrays.wrapper.ArrayWrapper<T>

Type Parameters:

T - The type of the array

Direct Known Subclasses:

ObjectArrayWrapper, StringArrayWrapper

public abstract class ArrayWrapper<T>
extends java.lang.Object

A wrapper for arrays to make them easier to use and add some useful methods.

Constructor Summary

Constructors

Constructor and Description
ArrayWrapper(T[] array)

Method Summary

Modifier and Type	Method and Description
void	add(T value) Add a value to the array.
void	addAll(ArrayWrapper<T> values) Add values from another ArrayWrapper to the array.
void	addAll(T... values) Add multiple values to the array.
boolean	contains(int index) Check if the index is in the array.
boolean	contains(T value) Check if the value is in the array.
T	get(int index) Get the value at the index.
T	get(int index, T def) Get the value at the index or the default value if the index is not in the array.
T[]	getArray()
boolean	getBoolean(int index) Get the value at the index as a boolean.
abstract boolean	getBoolean(int index, boolean def) Get the value at the index as a boolean or the default value if the index is not in the array.
byte	getByte(int index) Get the value at the index as a byte.
abstract byte	getByte(int index, byte def) Get the value at the index as a byte or the default value if the index is not in the array.
char	getChar(int index) Get the value at the index as a char.
abstract char	getChar(int index, char def) Get the value at the index as a char or the default value if the index is not in the array.
double	getDouble(int index) Get the value at the index as a double.
abstract double	getDouble(int index, double def) Get the value at the index as a double or the default value if the index is not in the array.
float	getFloat(int index) Get the value at the index as a float.
abstract float	getFloat(int index, float def) Get the value at the index as a float or the default value if the index is not in the array.
int	getInt(int index) Get the value at the index as an int.
abstract int	getInt(int index, int def) Get the value at the index as an int or the default value if the index is not in the array.
long	getLong(int index) Get the value at the index as a long.
abstract long	getLong(int index, long def) Get the value at the index as a long or the default value if the index is not in the array.
short	getShort(int index) Get the value at the index as a short.
abstract short	getShort(int index, short def) Get the value at the index as a char or the default value if the index is not in the array.
abstract boolean	isBoolean(int index) Check if the value at the index is a boolean.
abstract boolean	isByte(int index) Check if the value at the index is a byte.
abstract boolean	isChar(int index) Check if the value at the index is a char.
abstract boolean	isDouble(int index) Check if the value at the index is a double.
boolean	isEmpty()
abstract boolean	isFloat(int index) Check if the value at the index is a float.
abstract boolean	isInt(int index) Check if the value at the index is an int.
abstract boolean	isLong(int index) Check if the value at the index is a long.
boolean	isNotEmpty()
abstract boolean	isShort(int index) Check if the value at the index is a short.
int	length()
void	remove(int index) Remove a value from the array.
void	remove(T value) Remove a value from the array.
void	set(int index, T value) Set the value at the index.
T[]	slice(int start) Get a slice of the array starting at the given index.
T[]	slice(int start, int end) Get a slice of the array starting at the given index and ending at the given index.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArrayWrapper

public ArrayWrapper(T[] array)

Method Detail

getArray

public T[] getArray()

Returns:

The wrapped array

length

public int length()

Returns:

The length of the array

isEmpty

public boolean isEmpty()

Returns:

If the array is empty

isNotEmpty

public boolean isNotEmpty()

Returns:

If the wrapped array is not empty

contains

public boolean contains(int index)

Check if the index is in the array.

Parameters:

index - The index to check

Returns:

If the index is in the array

contains

public boolean contains(T value)

Check if the value is in the array.

Parameters:

value - The value to check

Returns:

If the value is in the array

get

public T get(int index)

Get the value at the index.

Parameters:

index - The index to get the value from

Returns:

The value at the index

Throws:

java.lang.ArrayIndexOutOfBoundsException - If the index is not in the array

get

public T get(int index,
             T def)

Get the value at the index or the default value if the index is not in the array.

Parameters:

index - The index to get the value from

def - The default value

Returns:

The value at the index or the default value

set

public void set(int index,
                T value)

Set the value at the index.

Parameters:

index - The index to set the value at

value - The value to set

add

public void add(T value)

Add a value to the array.

Parameters:

value - The value to add

addAll

@SafeVarargs
public final void addAll(T... values)

Add multiple values to the array.

Parameters:

values - The values to add

addAll

public void addAll(ArrayWrapper<T> values)

Add values from another ArrayWrapper to the array.

Parameters:

values - The ArrayWrapper to add the values from

remove

public void remove(int index)

Remove a value from the array.

Parameters:

index - The index to remove the value from

remove

public void remove(T value)

Remove a value from the array.
This will only remove the first occurrence of the value.

Parameters:

value - The value to remove

slice

public T[] slice(int start)

Get a slice of the array starting at the given index.

Parameters:

start - The index to start at

Returns:

The sliced array

slice

public T[] slice(int start,
                 int end)

Get a slice of the array starting at the given index and ending at the given index.

Parameters:

start - The index to start at

end - The index to end at

Returns:

The sliced array

isBoolean

public abstract boolean isBoolean(int index)

Check if the value at the index is a boolean.
If the index is not in the array this will return false.

Parameters:

index - The index to check

Returns:

If the value at the index is a boolean

isByte

public abstract boolean isByte(int index)

Check if the value at the index is a byte.
If the index is not in the array this will return false.

Parameters:

index - The index to check

Returns:

If the value at the index is a byte

isShort

public abstract boolean isShort(int index)

Check if the value at the index is a short.
If the index is not in the array this will return false.

Parameters:

index - The index to check

Returns:

If the value at the index is a short

isChar

public abstract boolean isChar(int index)

Check if the value at the index is a char.
If the index is not in the array this will return false.

Parameters:

index - The index to check

Returns:

If the value at the index is a char

isInt

public abstract boolean isInt(int index)

Check if the value at the index is an int.
If the index is not in the array this will return false.

Parameters:

index - The index to check

Returns:

If the value at the index is an int

isLong

public abstract boolean isLong(int index)

Check if the value at the index is a long.
If the index is not in the array this will return false.

Parameters:

index - The index to check

Returns:

If the value at the index is a long

isFloat

public abstract boolean isFloat(int index)

Check if the value at the index is a float.
If the index is not in the array this will return false.

Parameters:

index - The index to check

Returns:

If the value at the index is a float

isDouble

public abstract boolean isDouble(int index)

Check if the value at the index is a double.
If the index is not in the array this will return false.

Parameters:

index - The index to check

Returns:

If the value at the index is a double

getBoolean

public boolean getBoolean(int index)

Get the value at the index as a boolean.
If the index is not in the array this will return false.

Parameters:

index - The index to get the value from

Returns:

The value at the index as a boolean

getByte

public byte getByte(int index)

Get the value at the index as a byte.
If the index is not in the array this will return 0.

Parameters:

index - The index to get the value from

Returns:

The value at the index as a byte

getShort

public short getShort(int index)

Get the value at the index as a short.
If the index is not in the array this will return 0.

Parameters:

index - The index to get the value from

Returns:

The value at the index as a short

getChar

public char getChar(int index)

Get the value at the index as a char.
If the index is not in the array this will return 0.

Parameters:

index - The index to get the value from

Returns:

The value at the index as a char

getInt

public int getInt(int index)

Get the value at the index as an int.
If the index is not in the array this will return 0.

Parameters:

index - The index to get the value from

Returns:

The value at the index as an int

getLong

public long getLong(int index)

Get the value at the index as a long.
If the index is not in the array this will return 0.

Parameters:

index - The index to get the value from

Returns:

The value at the index as a long

getFloat

public float getFloat(int index)

Get the value at the index as a float.
If the index is not in the array this will return 0.

Parameters:

index - The index to get the value from

Returns:

The value at the index as a float

getDouble

public double getDouble(int index)

Get the value at the index as a double.
If the index is not in the array this will return 0.

Parameters:

index - The index to get the value from

Returns:

The value at the index as a double

getBoolean

public abstract boolean getBoolean(int index,
                                   boolean def)

Get the value at the index as a boolean or the default value if the index is not in the array.

Parameters:

index - The index to get the value from

def - The default value

Returns:

The value at the index as a boolean or the default value

getByte

public abstract byte getByte(int index,
                             byte def)

Get the value at the index as a byte or the default value if the index is not in the array.

Parameters:

index - The index to get the value from

def - The default value

Returns:

The value at the index as a byte or the default value

getShort

public abstract short getShort(int index,
                               short def)

Get the value at the index as a char or the default value if the index is not in the array.

Parameters:

index - The index to get the value from

def - The default value

Returns:

The value at the index as a char or the default value

getChar

public abstract char getChar(int index,
                             char def)

Get the value at the index as a char or the default value if the index is not in the array.

Parameters:

index - The index to get the value from

def - The default value

Returns:

The value at the index as a char or the default value

getInt

public abstract int getInt(int index,
                           int def)

Get the value at the index as an int or the default value if the index is not in the array.

Parameters:

index - The index to get the value from

def - The default value

Returns:

The value at the index as an int or the default value

getLong

public abstract long getLong(int index,
                             long def)

Get the value at the index as a long or the default value if the index is not in the array.

Parameters:

index - The index to get the value from

def - The default value

Returns:

The value at the index as a long or the default value

getFloat

public abstract float getFloat(int index,
                               float def)

Get the value at the index as a float or the default value if the index is not in the array.

Parameters:

index - The index to get the value from

def - The default value

Returns:

The value at the index as a float or the default value

getDouble

public abstract double getDouble(int index,
                                 double def)

Get the value at the index as a double or the default value if the index is not in the array.

Parameters:

index - The index to get the value from

def - The default value

Returns:

The value at the index as a double or the default value