Array (fxgl-base 0.5.1 API)

java.lang.Object
- com.almasb.fxgl.core.collection.Array<T>

All Implemented Interfaces:

Iterable<T>
```
public class Array<T>
extends Object
implements Iterable<T>
```
A resizable, ordered or unordered array of objects. If unordered, this class avoids a memory copy when removing elements (the last element is moved to the removed element's position).

Author:

Nathan Sweet

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Array.ArrayIterable<T>`
`static class`	`Array.ArrayIterator<T>`
`static class`	`Array.PredicateIterable<T>`
`static class`	`Array.PredicateIterator<T>`

Constructor Summary

Constructors
Constructor and Description
`Array()` Creates an ordered array with a capacity of 16.
`Array(Array<? extends T> array)` Creates a new array containing the elements in the specified array.
`Array(Class arrayType)` Creates an ordered array with `items` of the specified type and a capacity of 16.
`Array(Collection<T> collection)` Creates a new ordered array containing the elements of the given collection.
`Array(int capacity)` Creates an ordered array with the specified capacity.
`Array(T[] array)` Creates a new ordered array containing the elements in the specified array.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(T value)`
`void`	`addAll(Array<? extends T> array)`
`void`	`addAll(Array<? extends T> array, int start, int count)`
`void`	`addAll(T... array)`
`void`	`addAll(T[] array, int start, int count)`
`void`	`clear()` Removes all items.
`boolean`	`containsByEquality(T value)`
`boolean`	`containsByIdentity(T value)`
`static <T> Array<T>`	`empty()`
`T[]`	`ensureCapacity(int additionalCapacity)` Increases the size of the backing array to accommodate the specified number of additional items.
`boolean`	`equals(Object object)`
`T`	`first()`
`T`	`get(int index)`
`T[]`	`getItems()`
`int`	`hashCode()`
`int`	`indexOfByEquality(T value)`
`int`	`indexOfByIdentity(T value)`
`void`	`insert(int index, T value)`
`boolean`	`isEmpty()`
`boolean`	`isNotEmpty()`
`boolean`	`isOrdered()`
`Iterator<T>`	`iterator()` Returns an iterator for the items in the array.
`T`	`last()`
`int`	`lastIndexOfByEquality(T value)`
`int`	`lastIndexOfByIdentity(T value)`
`static <T> Array<T>`	`of(boolean ordered, int capacity, Class<T> arrayType)`
`static <T> Array<T>`	`of(Class<T> arrayType)`
`T`	`pop()` Removes and returns the last item.
`T`	`random()`
`boolean`	`removeAllByEquality(Array<? extends T> array)` Removes from this array all of elements contained in the specified array using .equals() to check.
`boolean`	`removeAllByIdentity(Array<? extends T> array)` Removes from this array all of elements contained in the specified array using == to check.
`T`	`removeIndex(int index)` Removes and returns the item at the specified index.
`void`	`removeRange(int start, int end)` Removes the items between the specified indices, inclusive.
`boolean`	`removeValueByEquality(T value)` Removes the first instance of the specified value in the array.
`boolean`	`removeValueByIdentity(T value)` Removes the first instance of the specified value in the array.
`protected T[]`	`resize(int newSize)` Creates a new backing array with the specified size containing the current items.
`void`	`reverse()` Reverses the items.
`Iterable<T>`	`select(Predicate<T> predicate)` Returns an iterable for the selected items in the array.
`T`	`selectRanked(Comparator<T> comparator, int kthLowest)` Selects the nth-lowest element from the Array according to Comparator ranking.
`int`	`selectRankedIndex(Comparator<T> comparator, int kthLowest)`
`void`	`set(int index, T value)`
`T[]`	`setSize(int newSize)` Sets the array size, leaving any values beyond the current size null.
`T[]`	`shrink()` Reduces the size of the backing array to the size of the actual items.
`void`	`shuffle()` Shuffles the items.
`int`	`size()`
`void`	`sort()` Sorts this array.
`void`	`sort(Comparator<? super T> comparator)` Sorts the array using given comparator.
`void`	`swap(int first, int second)`
`T[]`	`toArray()` Returns the items as an array.
`<V> V[]`	`toArray(Class type)`
`List<T>`	`toList()`
`String`	`toString()`
`String`	`toString(String separator)`
`void`	`truncate(int newSize)` Reduces the size of the array to the specified size.
`static <T> Array<T>`	`with(T... array)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Array
```
public Array()
```
    Creates an ordered array with a capacity of 16.
  - Array
```
public Array(int capacity)
```
    Creates an ordered array with the specified capacity.
    
    Parameters:
    
    capacity - initial capacity
  - Array
```
public Array(Class arrayType)
```
    Creates an ordered array with items of the specified type and a capacity of 16.
  - Array
```
public Array(Array<? extends T> array)
```
    Creates a new array containing the elements in the specified array. The new array will have the same type of backing array and will be ordered if the specified array is ordered. The capacity is set to the number of elements, so any subsequent elements added will cause the backing array to be grown.
  - Array
```
public Array(T[] array)
```
    Creates a new ordered array containing the elements in the specified array. The new array will have the same type of backing array. The capacity is set to the number of elements, so any subsequent elements added will cause the backing array to be grown.
  - Array
```
public Array(Collection<T> collection)
```
    Creates a new ordered array containing the elements of the given collection. The order of elements placed in the array is dependent on the collection implementation.
    
    Parameters:
    
    collection - the collection to take elements from
- Method Detail
  - getItems
```
public T[] getItems()
```
    Returns:
    
    direct access to the underlying array
  - size
```
public int size()
```
  - isEmpty
```
public boolean isEmpty()
```
  - isNotEmpty
```
public boolean isNotEmpty()
```
  - isOrdered
```
public boolean isOrdered()
```
  - add
```
public void add(T value)
```
  - addAll
```
public void addAll(Array<? extends T> array)
```
  - addAll
```
public void addAll(Array<? extends T> array,
                   int start,
                   int count)
```
  - addAll
```
public void addAll(T... array)
```
  - addAll
```
public void addAll(T[] array,
                   int start,
                   int count)
```
  - get
```
public T get(int index)
```
  - set
```
public void set(int index,
                T value)
```
  - insert
```
public void insert(int index,
                   T value)
```
  - swap
```
public void swap(int first,
                 int second)
```
  - containsByIdentity
```
public boolean containsByIdentity(T value)
```
    Parameters:
    
    value - May be null, the identity "==" comparison is used
    
    Returns:
    
    true if array contains value, false if it doesn't
  - containsByEquality
```
public boolean containsByEquality(T value)
```
    Parameters:
    
    value - May be null, the equality ".equals" comparison is used
    
    Returns:
    
    true if array contains value, false if it doesn't
  - indexOfByIdentity
```
public int indexOfByIdentity(T value)
```
    Parameters:
    
    value - May be null, the identity "==" comparison is used
    
    Returns:
    
    An index of first occurrence of value in array or -1 if no such value exists
  - indexOfByEquality
```
public int indexOfByEquality(T value)
```
    Parameters:
    
    value - May be null, the equality ".equals" comparison is used
    
    Returns:
    
    An index of first occurrence of value in array or -1 if no such value exists
  - lastIndexOfByIdentity
```
public int lastIndexOfByIdentity(T value)
```
    Parameters:
    
    value - May be null, the identity "==" comparison is used
    
    Returns:
    
    An index of last occurrence of value in array or -1 if no such value exists
  - lastIndexOfByEquality
```
public int lastIndexOfByEquality(T value)
```
    Parameters:
    
    value - May be null, the equality ".equals" comparison is used
    
    Returns:
    
    An index of last occurrence of value in array or -1 if no such value exists
  - removeValueByIdentity
```
public boolean removeValueByIdentity(T value)
```
    Removes the first instance of the specified value in the array.
    
    Parameters:
    
    value - the value to compare against using identity (==)
    
    Returns:
    
    true if value was found and removed, false otherwise
  - removeValueByEquality
```
public boolean removeValueByEquality(T value)
```
    Removes the first instance of the specified value in the array.
    
    Parameters:
    
    value - the value to compare against using equality (.equals())
    
    Returns:
    
    true if value was found and removed, false otherwise
  - removeIndex
```
public T removeIndex(int index)
```
    Removes and returns the item at the specified index.
    
    Parameters:
    
    index - the index of the element to remove
    
    Returns:
    
    removed element
  - removeRange
```
public void removeRange(int start,
                        int end)
```
    Removes the items between the specified indices, inclusive.
    
    Parameters:
    
    start - start index
    
    end - end index
  - removeAllByIdentity
```
public boolean removeAllByIdentity(Array<? extends T> array)
```
    Removes from this array all of elements contained in the specified array using == to check.
    
    Parameters:
    
    array - given array
    
    Returns:
    
    true if this array was modified
  - removeAllByEquality
```
public boolean removeAllByEquality(Array<? extends T> array)
```
    Removes from this array all of elements contained in the specified array using .equals() to check.
    
    Parameters:
    
    array - given array
    
    Returns:
    
    true if this array was modified
  - pop
```
public T pop()
```
    Removes and returns the last item.
    
    Returns:
    
    last item
  - last
```
public T last()
```
    Returns:
    
    the last item
  - first
```
public T first()
```
    Returns:
    
    the first item
  - clear
```
public void clear()
```
    Removes all items.
  - shrink
```
public T[] shrink()
```
    Reduces the size of the backing array to the size of the actual items. This is useful to release memory when many items have been removed, or if it is known that more items will not be added.
    
    Returns:
    
    items
  - ensureCapacity
```
public T[] ensureCapacity(int additionalCapacity)
```
    Increases the size of the backing array to accommodate the specified number of additional items. Useful before adding many items to avoid multiple backing array resizes.
    
    Parameters:
    
    additionalCapacity - extra capacity
    
    Returns:
    
    items
  - setSize
```
public T[] setSize(int newSize)
```
    Sets the array size, leaving any values beyond the current size null.
    
    Parameters:
    
    newSize - new array size
    
    Returns:
    
    items
  - resize
```
protected T[] resize(int newSize)
```
    Creates a new backing array with the specified size containing the current items.
    
    Parameters:
    
    newSize - new array size
    
    Returns:
    
    items
  - truncate
```
public void truncate(int newSize)
```
    Reduces the size of the array to the specified size. If the array is already smaller than the specified size, no action is taken.
    
    Parameters:
    
    newSize - new array size
  - sort
```
public void sort()
```
    Sorts this array. The array elements must implement Comparable. This method is not thread safe (uses Sort.instance()).
  - sort
```
public void sort(Comparator<? super T> comparator)
```
    Sorts the array using given comparator. This method is not thread safe (uses Sort.instance()).
    
    Parameters:
    
    comparator - comparator for sorting
  - reverse
```
public void reverse()
```
    Reverses the items.
  - shuffle
```
public void shuffle()
```
    Shuffles the items.
  - iterator
```
public Iterator<T> iterator()
```
    Returns an iterator for the items in the array. Remove is supported. Note that the same iterator instance is returned each time this method is called. Use the Array.ArrayIterator constructor for nested or multithreaded iteration.
    
    Specified by:
    
    iterator in interface Iterable<T>
    
    Returns:
    
    iterator
  - select
```
public Iterable<T> select(Predicate<T> predicate)
```
    Returns an iterable for the selected items in the array. Remove is supported, but not between hasNext() and next(). Note that the same iterable instance is returned each time this method is called. Use the Array.PredicateIterable constructor for nested or multithreaded iteration.
    
    Parameters:
    
    predicate - predicate for selection
    
    Returns:
    
    an iterable for the selected items in the array
  - selectRanked
```
public T selectRanked(Comparator<T> comparator,
                      int kthLowest)
```
    Selects the nth-lowest element from the Array according to Comparator ranking. This might partially sort the Array. The array must have a size greater than 0, or a IllegalArgumentException will be thrown.
    
    Parameters:
    
    comparator - used for comparison
    
    kthLowest - rank of desired object according to comparison, n is based on ordinal numbers, not array indices. for min value use 1, for max value use size of array, using 0 results in runtime exception.
    
    Returns:
    
    the value of the Nth lowest ranked object.
    
    See Also:
    
    Select
  - selectRankedIndex
```
public int selectRankedIndex(Comparator<T> comparator,
                             int kthLowest)
```
    Parameters:
    
    comparator - used for comparison
    
    kthLowest - rank of desired object according to comparison, n is based on ordinal numbers, not array indices. for min value use 1, for max value use size of array, using 0 results in runtime exception.
    
    Returns:
    
    the index of the Nth lowest ranked object.
    
    See Also:
    
    selectRanked(Comparator, int)
  - random
```
public T random()
```
    Returns:
    
    a random item from the array
  - toArray
```
public T[] toArray()
```
    Returns the items as an array. Note the array is typed, so the Array(Class) constructor must have been used. Otherwise use toArray(Class) to specify the array type.
    
    Returns:
    
    Java array with items
  - toArray
```
public <V> V[] toArray(Class type)
```
  - toList
```
public List<T> toList()
```
    Returns:
    
    new list containing items from this Array
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toString
```
public String toString(String separator)
```
  - of
```
public static <T> Array<T> of(Class<T> arrayType)
```
    See Also:
    
    Array(Class)
  - of
```
public static <T> Array<T> of(boolean ordered,
                              int capacity,
                              Class<T> arrayType)
```
    See Also:
    
    Array(boolean, int, Class)
  - with
```
public static <T> Array<T> with(T... array)
```
    See Also:
    
    Array(Object[])
  - empty
```
public static <T> Array<T> empty()
```

Class Array<T>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Array

Array

Array

Array

Array

Array

Method Detail

getItems

size

isEmpty

isNotEmpty

isOrdered

add

addAll

addAll

addAll

addAll

get

set

insert

swap

containsByIdentity

containsByEquality

indexOfByIdentity

indexOfByEquality

lastIndexOfByIdentity

lastIndexOfByEquality

removeValueByIdentity

removeValueByEquality

removeIndex

removeRange

removeAllByIdentity

removeAllByEquality

pop

last

first

clear

shrink

ensureCapacity

setSize

resize

truncate

sort

sort

reverse

shuffle

iterator

select

selectRanked

selectRankedIndex

random

toArray

toArray

toList

hashCode

equals

toString

toString

of

of

with

empty