org.joda.primitives.list.impl
Class ArrayShortList

java.lang.Object
  org.joda.primitives.collection.impl.AbstractPrimitiveCollectable<Short>
      org.joda.primitives.collection.impl.AbstractShortCollection
          org.joda.primitives.list.impl.AbstractShortList
              org.joda.primitives.list.impl.ArrayShortList

All Implemented Interfaces:

Cloneable, Iterable<Short>, Collection<Short>, List<Short>, PrimitiveCollection<Short>, ShortCollection, ShortIterable, PrimitiveList<Short>, ShortList, PrimitiveCollectable<Short>

public class ArrayShortList
extends AbstractShortList
implements Cloneable

Array based implementation of ShortList for primitive int elements.

This class implements List allowing seamless integration with other APIs.

Add, Remove, Set and Clear are supported.

Since:

1.0

Version:

CODE GENERATED

Author:

Stephen Colebourne, Rodney Waldhoff, Jason Tiscione

Nested Class Summary

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

AbstractShortList.PListIterator

Constructor Summary

ArrayShortList()
Constructor.

ArrayShortList(Collection<Short> coll)
Constructor that copies the specified values.

ArrayShortList(int initialSize)
Constructor that defines an initial size for the internal storage array.

ArrayShortList(short[] values)
Constructor that copies the specified values.

Method Summary

boolean	add(int index, short value) Adds a primitive value to this collection.
boolean	addAll(int index, short[] values) Adds an array of primitive values to this collection at a specified index.
protected void	arrayCopy(int fromIndex, short[] dest, int destIndex, int size) Copies data from this collection into the specified array.
void	clear() Clears the collection/map of all elements.
Object	clone() Clone implementation that calls Object clone().
boolean	contains(short value) Checks whether this collection contains a specified primitive value.
protected void	ensureCapacity(int capacity) Ensures that the internal storage array has at least the specified size.
short	getShort(int index) Gets the primitive value at the specified index.
protected boolean	isAddModifiable() Are the add methods supported.
boolean	isModifiable() Checks whether the object can currently be modified.
protected boolean	isRemoveModifiable() Are the remove methods supported.
protected boolean	isSetModifiable() Are the remove methods supported.
void	optimize() Optimizes the implementation.
boolean	removeRange(int fromIndexInclusive, int toIndexExclusive) Removes a range of values from the list.
short	removeShortAt(int index) Removes a primitive value by index from the list.
short	set(int index, short value) Sets the primitive value at a specified index.
int	size() Gets the current size of the collection.

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

add, add, add, addAll, addAll, checkIndex, checkIndexExists, checkRange, checkSetModifiable, equals, first, firstShort, get, hashCode, indexOf, indexOf, indexOf, indexOf, iterator, last, lastIndexOf, lastIndexOf, lastIndexOf, lastIndexOf, lastShort, listIterator, listIterator, remove, removeShort, set, subList, toShortArray

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

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

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

isEmpty

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

Methods inherited from interface java.util.List

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

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

addAll, addAll, containsAll, containsAll, containsAll, containsAny, containsAny, containsAny, removeAll, removeAll, removeAll, removeAll, removeFirst, retainAll, retainAll, retainAll, toShortArray, toShortArray

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

containsAny

Methods inherited from interface org.joda.primitives.PrimitiveCollectable

isEmpty

Constructor Detail

ArrayShortList

public ArrayShortList()

Constructor.

ArrayShortList

public ArrayShortList(int initialSize)

Constructor that defines an initial size for the internal storage array.

Parameters:

initialSize - the initial size of the internal array, negative treated as zero

ArrayShortList

public ArrayShortList(short[] values)

Constructor that copies the specified values.

Parameters:

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

ArrayShortList

public ArrayShortList(Collection<Short> coll)

Constructor that copies the specified values.

Parameters:

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

Method Detail

size

public int size()

Gets the current size of the collection.

Specified by:

size in interface Collection<Short>

Specified by:

size in interface List<Short>

Specified by:

size in interface PrimitiveCollectable<Short>

Returns:

the current size

getShort

public short getShort(int index)

Gets the primitive value at the specified index.

Specified by:

getShort in interface ShortList

Parameters:

index - the index to get from

Returns:

value at the index

Throws:

IndexOutOfBoundsException - if the index is invalid

add

public boolean add(int index,
                   short value)

Adds a primitive value to this collection.

Specified by:

add in interface ShortList

Overrides:

add in class AbstractShortList

Parameters:

index - the index to insert at

value - the value to add to this collection

Returns:

true if this collection was modified by this method call

Throws:

IndexOutOfBoundsException - if the index is invalid

removeShortAt

public short removeShortAt(int index)

Removes a primitive value by index from the list.

Specified by:

removeShortAt in interface ShortList

Overrides:

removeShortAt in class AbstractShortList

Parameters:

index - the index to remove from

Returns:

the primitive value previously at this index

Throws:

IndexOutOfBoundsException - if the index is invalid

removeRange

public boolean removeRange(int fromIndexInclusive,
                           int toIndexExclusive)

Removes a range of values from the list.

Specified by:

removeRange in interface PrimitiveList<Short>

Overrides:

removeRange in class AbstractShortList

Parameters:

fromIndexInclusive - the start of the range to remove, inclusive

toIndexExclusive - the end of the range to remove, exclusive

Returns:

true if the collection was modified

set

public short set(int index,
                 short value)

Sets the primitive value at a specified index.

Specified by:

set in interface ShortList

Overrides:

set in class AbstractShortList

Parameters:

index - the index to set

value - the value to store

Returns:

the previous value at the index

Throws:

IndexOutOfBoundsException - if the index is invalid

optimize

public void optimize()

Optimizes the implementation.

This implementation changes the internal array to be the same size as the size of the collection.

Specified by:

optimize in interface PrimitiveCollectable<Short>

Overrides:

optimize in class AbstractPrimitiveCollectable<Short>

clear

public void clear()

Clears the collection/map of all elements.

This implementation resets the size, but does not reduce the internal storage array.

The collection/map will have a zero size after this method completes.

Specified by:

clear in interface Collection<Short>

Specified by:

clear in interface List<Short>

Specified by:

clear in interface PrimitiveCollectable<Short>

Overrides:

clear in class AbstractShortList

contains

public boolean contains(short value)

Checks whether this collection contains a specified primitive value.

This implementation accesses the internal storage array directly.

Specified by:

contains in interface ShortCollection

Overrides:

contains in class AbstractShortList

Parameters:

value - the value to search for

Returns:

true if the value is found

addAll

public boolean addAll(int index,
                      short[] values)

Adds an array of primitive values to this collection at a specified index.

Specified by:

addAll in interface ShortList

Overrides:

addAll in class AbstractShortList

Parameters:

index - the index to add at

values - the values to add to this collection

Returns:

true if this collection was modified by this method call

Throws:

IndexOutOfBoundsException - if the index is invalid

isAddModifiable

protected boolean isAddModifiable()

Are the add methods supported.

Overrides:

isAddModifiable in class AbstractShortCollection

Returns:

true

isRemoveModifiable

protected boolean isRemoveModifiable()

Are the remove methods supported.

Overrides:

isRemoveModifiable in class AbstractShortCollection

Returns:

true

isSetModifiable

protected boolean isSetModifiable()

Are the remove methods supported.

Overrides:

isSetModifiable in class AbstractShortList

Returns:

true

isModifiable

public boolean isModifiable()

Checks whether the object can currently be modified.

Specified by:

isModifiable in interface PrimitiveCollectable<Short>

Overrides:

isModifiable in class AbstractShortList

Returns:

true

clone

public Object clone()

Clone implementation that calls Object clone().

Specified by:

clone in interface PrimitiveCollectable<Short>

Overrides:

clone in class AbstractPrimitiveCollectable<Short>

Returns:

the clone

arrayCopy

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

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

Overrides:

arrayCopy in class AbstractShortList

Parameters:

fromIndex - the index to start from

dest - the destination array

destIndex - the destination start index

size - the number of items to copy

ensureCapacity

protected void ensureCapacity(int capacity)

Ensures that the internal storage array has at least the specified size.

Parameters:

capacity - the amount to expand to