org.joda.primitives.list.impl
Class ImmutableArrayCharList

java.lang.Object
  org.joda.primitives.collection.impl.AbstractPrimitiveCollectable<Character>
      org.joda.primitives.collection.impl.AbstractCharCollection
          org.joda.primitives.list.impl.AbstractCharList
              org.joda.primitives.list.impl.ImmutableArrayCharList

All Implemented Interfaces:

Iterable<Character>, Collection<Character>, List<Character>, CharCollection, PrimitiveCollection<Character>, CharIterable, CharList, PrimitiveList<Character>, PrimitiveCollectable<Character>

public final class ImmutableArrayCharList
extends AbstractCharList

Immutable array-based implementation of CharList for primitive int elements.

This class implements List allowing seamless integration with other APIs.

Add, Remove, Set and Clear are not supported as this class is immutable.

Since:

1.0

Version:

CODE GENERATED

Author:

Stephen Colebourne

Nested Class Summary

Nested classes/interfaces inherited from class org.joda.primitives.list.impl.AbstractCharList

AbstractCharList.PListIterator

Method Summary

protected void	arrayCopy(int fromIndex, char[] dest, int destIndex, int size) Copies data from this collection into the specified array.
Object	clone() Clone implementation that returns this.
boolean	contains(char value) Checks whether this collection contains a specified primitive value.
static ImmutableArrayCharList	copyOf(char[] values) Creates a list copying the specified array.
static ImmutableArrayCharList	copyOf(Collection<Character> coll) Creates a list copying the values from the specified collection.
static ImmutableArrayCharList	empty() Gets a list that is empty.
char	getChar(int index) Gets the primitive value at the specified index.
int	size() Gets the current size of the collection.

Methods inherited from class org.joda.primitives.list.impl.AbstractCharList

add, add, add, add, addAll, addAll, addAll, checkIndex, checkIndexExists, checkRange, checkSetModifiable, clear, equals, first, firstChar, get, hashCode, indexOf, indexOf, indexOf, indexOf, isModifiable, isSetModifiable, iterator, last, lastChar, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOf, listIterator, listIterator, remove, removeChar, removeCharAt, removeRange, set, set, subList, toCharArray, toStringContents

Methods inherited from class org.joda.primitives.collection.impl.AbstractCharCollection

addAll, addAll, addAll, checkAddModifiable, checkRemoveModifiable, contains, containsAll, containsAll, containsAll, containsAll, containsAny, containsAny, containsAny, containsAny, isAddModifiable, isRemoveModifiable, isToPrimitivePossible, remove, removeAll, removeAll, removeAll, removeAll, removeAll, removeFirst, retainAll, retainAll, retainAll, retainAll, toArray, toArray, toCharArray, toCharArray, toObject, toPrimitive, toPrimitiveArray, toString

Methods inherited from class org.joda.primitives.collection.impl.AbstractPrimitiveCollectable

isEmpty, optimize

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.joda.primitives.collection.PrimitiveCollection

containsAny

Methods inherited from interface org.joda.primitives.PrimitiveCollectable

isEmpty, optimize

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from interface org.joda.primitives.collection.CharCollection

addAll, addAll, containsAll, containsAll, containsAll, containsAny, containsAny, containsAny, removeAll, removeAll, removeAll, removeAll, removeFirst, retainAll, retainAll, retainAll, toCharArray, toCharArray

Methods inherited from interface org.joda.primitives.collection.PrimitiveCollection

containsAny

Methods inherited from interface org.joda.primitives.PrimitiveCollectable

isEmpty, optimize

Method Detail

empty

public static ImmutableArrayCharList empty()

Gets a list that is empty.

copyOf

public static ImmutableArrayCharList copyOf(char[] values)

Creates a list copying the specified array.

Parameters:

values - an array of values to copy, null treated as zero size array

Returns:

the created list, not null

copyOf

public static ImmutableArrayCharList copyOf(Collection<Character> coll)

Creates a list copying the values from the specified collection.

If the collection is an instance of this class, then it is simply returned.

Parameters:

coll - a collection of values to copy, null treated as zero size collection

Returns:

the created list, not null

size

public int size()

Gets the current size of the collection.

Returns:

the current size

getChar

public char getChar(int index)

Gets the primitive value at the specified index.

Parameters:

index - the index to get from

Returns:

value at the index

Throws:

IndexOutOfBoundsException - if the index is invalid

contains

public boolean contains(char value)

Checks whether this collection contains a specified primitive value.

This implementation accesses the internal storage array directly.

Specified by:

contains in interface CharCollection

Overrides:

contains in class AbstractCharList

Parameters:

value - the value to search for

Returns:

true if the value is found

clone

public Object clone()

Clone implementation that returns this.

Specified by:

clone in interface PrimitiveCollectable<Character>

Overrides:

clone in class AbstractPrimitiveCollectable<Character>

Returns:

this

arrayCopy

protected void arrayCopy(int fromIndex,
                         char[] dest,
                         int destIndex,
                         int size)

Copies data from this collection into the specified array. This method is pre-validated.

Overrides:

arrayCopy in class AbstractCharList

Parameters:

fromIndex - the index to start from

dest - the destination array

destIndex - the destination start index

size - the number of items to copy