Package squidpony.squidmath

Class MultiArrangement.KeyList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<K>

squidpony.squidmath.MultiArrangement.KeyList

All Implemented Interfaces:

Serializable, Iterable<K>, Collection<K>, List<K>

Enclosing class:

MultiArrangement<K>

public final class MultiArrangement.KeyList
extends AbstractList<K>
implements Serializable

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
KeyList()

Method Summary

Modifier and Type	Method	Description
boolean	add(K o)	Always throws an UnsupportedOperationException
boolean	addAll(Collection<? extends K> c)	Always throws an UnsupportedOperationException.
void	clear()
boolean	contains(Object o)	Delegates to the corresponding type-specific method.
boolean	containsAll(Collection<?> c)	Checks whether this collection contains all elements from the given type-specific collection.
boolean	equals(Object o)
K	first()
K	get(int index)
boolean	isEmpty()
MultiArrangement.KeyIterator	iterator()
K	last()
boolean	remove(Object ok)	Always throws an UnsupportedOperationException
boolean	removeAll(Collection<?> c)	Remove from this collection all elements in the given type-specific collection.
boolean	retainAll(Collection<?> c)	Retains in this collection only elements from the given type-specific collection.
int	size()
Object[]	toArray()
<T> T[]	toArray(T[] a)
String	toString()
int	unwrap(MultiArrangement.KeyIterator i, Object[] array)	Unwraps an iterator into an array.
int	unwrap(MultiArrangement.KeyIterator i, Object[] array, int offset, int max)	Unwraps an iterator into an array starting at a given offset for a given number of elements.

Methods inherited from class java.util.AbstractList

add, addAll, hashCode, indexOf, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Constructor Details

KeyList

public KeyList()

Method Details

iterator

public MultiArrangement.KeyIterator iterator()

Specified by:

iterator in interface Collection<K>

Specified by:

iterator in interface Iterable<K>

Specified by:

iterator in interface List<K>

Overrides:

iterator in class AbstractList<K>

size

public int size()

Specified by:

size in interface Collection<K>

Specified by:

size in interface List<K>

Specified by:

size in class AbstractCollection<K>

clear

public void clear()

Specified by:

clear in interface Collection<K>

Specified by:

clear in interface List<K>

Overrides:

clear in class AbstractList<K>

first

public K first()

last

public K last()

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<K>

Specified by:

toArray in interface List<K>

Overrides:

toArray in class AbstractCollection<K>

remove

public boolean remove(Object ok)

Always throws an UnsupportedOperationException

Specified by:

remove in interface Collection<K>

Specified by:

remove in interface List<K>

Overrides:

remove in class AbstractCollection<K>

add

public boolean add(K o)

Always throws an UnsupportedOperationException

Specified by:

add in interface Collection<K>

Specified by:

add in interface List<K>

Overrides:

add in class AbstractList<K>

get

public K get(int index)

Specified by:

get in interface List<K>

Specified by:

get in class AbstractList<K>

Parameters:

index -

Throws:

IndexOutOfBoundsException

contains

public boolean contains(Object o)

Delegates to the corresponding type-specific method.

Specified by:

contains in interface Collection<K>

Specified by:

contains in interface List<K>

Overrides:

contains in class AbstractCollection<K>

containsAll

public boolean containsAll(Collection<?> c)

Checks whether this collection contains all elements from the given type-specific collection.

Specified by:

containsAll in interface Collection<K>

Specified by:

containsAll in interface List<K>

Overrides:

containsAll in class AbstractCollection<K>

Parameters:

c - a type-specific collection.

Returns:

true if this collection contains all elements of the argument.

retainAll

public boolean retainAll(Collection<?> c)

Retains in this collection only elements from the given type-specific collection.

Specified by:

retainAll in interface Collection<K>

Specified by:

retainAll in interface List<K>

Overrides:

retainAll in class AbstractCollection<K>

Parameters:

c - a type-specific collection.

Returns:

true if this collection changed as a result of the call.

removeAll

public boolean removeAll(Collection<?> c)

Remove from this collection all elements in the given type-specific collection.

Specified by:

removeAll in interface Collection<K>

Specified by:

removeAll in interface List<K>

Overrides:

removeAll in class AbstractCollection<K>

Parameters:

c - a type-specific collection.

Returns:

true if this collection changed as a result of the call.

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<K>

Specified by:

toArray in interface List<K>

Overrides:

toArray in class AbstractCollection<K>

addAll

public boolean addAll(Collection<? extends K> c)

Always throws an UnsupportedOperationException.

Specified by:

addAll in interface Collection<K>

Specified by:

addAll in interface List<K>

Overrides:

addAll in class AbstractCollection<K>

Parameters:

c - disregarded; always throws Exception

Returns:

nothing; always throws Exception

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<K>

Specified by:

equals in interface List<K>

Overrides:

equals in class AbstractList<K>

unwrap

public int unwrap(MultiArrangement.KeyIterator i, Object[] array, int offset, int max)

Unwraps an iterator into an array starting at a given offset for a given number of elements.

This method iterates over the given type-specific iterator and stores the elements returned, up to a maximum of length, in the given array starting at offset. The number of actually unwrapped elements is returned (it may be less than max if the iterator emits less than max elements).

Parameters:

i - a type-specific iterator.

array - an array to contain the output of the iterator.

offset - the first element of the array to be returned.

max - the maximum number of elements to unwrap.

Returns:

the number of elements unwrapped.

unwrap

public int unwrap(MultiArrangement.KeyIterator i, Object[] array)

Unwraps an iterator into an array.

This method iterates over the given type-specific iterator and stores the elements returned in the given array. The iteration will stop when the iterator has no more elements or when the end of the array has been reached.

Parameters:

i - a type-specific iterator.

array - an array to contain the output of the iterator.

Returns:

the number of elements unwrapped.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<K>

Specified by:

isEmpty in interface List<K>

Overrides:

isEmpty in class AbstractCollection<K>

toString

public String toString()

Overrides:

toString in class AbstractCollection<K>