com.augustbonds.foundation

Class Array<E>

java.lang.Object

com.augustbonds.foundation.Array<E>

Type Parameters:

E - The type of objects stored in this Array

All Implemented Interfaces:

Iterable<E>

public class Array<E>
extends Object
implements Iterable<E>

The Array class is the default ordered collection. It is backed by an array, and grows to fit it's contents dynamically.

Constructor Summary

Constructors

Constructor and Description
Array() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	append(E element) Appends an element to the end of the Array.
Array<E>	filter(java.util.function.Predicate<E> predicate) Filter this Array by a given Predicate.
E	get(int index) Get the element at a specific index.
Iterator<E>	iterator() Return an iterator for this Array.
<O> Array<O>	map(java.util.function.Function<E,O> toMap) Apply a function to each element of the Array, and return an Array of the returned elements.
void	remove(int index) Removes an element at a specific index and shrinks the Array.
void	set(int index, E element) Sets the element at a specific index.
int	size() Returns the size of the Array.
void	sort(Comparator<E> comparator) Perform an in-place sorting of the elements in the Array.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Array

public Array()

Default constructor.

Method Detail

size

public int size()

Returns the size of the Array.

Returns:

the size of the Array.

append

public void append(E element)

Appends an element to the end of the Array.

Parameters:

element - The element to append.

set

public void set(int index,
                E element)

Sets the element at a specific index. The index must be within [0,size()), or else a OutOfBoundsException will be thrown.

Parameters:

index - The target index.

element - The element to be set.

remove

public void remove(int index)

Removes an element at a specific index and shrinks the Array. The index must be within [0,size()), or else a OutOfBoundsException will be thrown.

Parameters:

index - The index of the element to remove.

map

public <O> Array<O> map(java.util.function.Function<E,O> toMap)

Apply a function to each element of the Array, and return an Array of the returned elements.

Type Parameters:

O - The type of the objects stored in the returned Array.

Parameters:

toMap - The function to apply to objects stored in the Array.

Returns:

An Array of elements as the result of applying toMap to every element in the Array.

get

public E get(int index)

Get the element at a specific index.

Parameters:

index - The index of the requested element.

Returns:

The element, if it exists. Null otherwise.

filter

public Array<E> filter(java.util.function.Predicate<E> predicate)

Filter this Array by a given Predicate.

Parameters:

predicate - The predicate on which to filter this Array.

Returns:

An Array consisting of the objects in this Array satisfying the predicate.

sort

public void sort(Comparator<E> comparator)

Perform an in-place sorting of the elements in the Array.

Parameters:

comparator - The comparator on which to base the ordering.

iterator

public Iterator<E> iterator()

Return an iterator for this Array.

Specified by:

iterator in interface Iterable<E>

Returns:

An iterator for this Array.