org.opentrafficsim.base.immutablecollections

Class ImmutableArrayList<E>

java.lang.Object

org.opentrafficsim.base.immutablecollections.ImmutableAbstractList<E>

org.opentrafficsim.base.immutablecollections.ImmutableArrayList<E>

Type Parameters:

E - the type of content of this List

All Implemented Interfaces:

Serializable, Iterable<E>, RandomAccess, ImmutableCollection<E>, ImmutableList<E>

public class ImmutableArrayList<E>
extends ImmutableAbstractList<E>

An immutable wrapper for an ArrayList.

Copyright (c) 2013-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version May 7, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImmutableArrayList(ImmutableList<E> list)
ImmutableArrayList(ImmutableList<E> list, Immutable copyOrWrap)
ImmutableArrayList(List<E> list)
ImmutableArrayList(List<E> list, Immutable copyOrWrap)

Method Summary

Modifier and Type	Method and Description
protected ArrayList<E>	getList() Prepare the list of the right type for use a subclass.
ImmutableList<E>	subList(int fromIndex, int toIndex) Returns a safe, immutable copy of the portion of this immutable list between the specified fromIndex, inclusive, and toIndex, exclusive.
List<E>	toList() Returns a modifiable copy of this immutable list.
String	toString()

Methods inherited from class org.opentrafficsim.base.immutablecollections.ImmutableAbstractList

contains, containsAll, containsAll, equals, forEach, get, hashCode, indexOf, isEmpty, isWrap, iterator, lastIndexOf, parallelStream, size, spliterator, stream, toArray, toArray, toCollection

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opentrafficsim.base.immutablecollections.ImmutableCollection

isCopy

Constructor Detail

ImmutableArrayList

public ImmutableArrayList(List<E> list)

Parameters:

list - the list to use as the immutable list.

ImmutableArrayList

public ImmutableArrayList(List<E> list,
                          Immutable copyOrWrap)

Parameters:

list - the list to use as the immutable list.

copyOrWrap - COPY stores a safe, internal copy of the collection; WRAP stores a pointer to the original collection

ImmutableArrayList

public ImmutableArrayList(ImmutableList<E> list)

Parameters:

list - the list to use as the immutable list.

ImmutableArrayList

public ImmutableArrayList(ImmutableList<E> list,
                          Immutable copyOrWrap)

Parameters:

list - the list to use as the immutable list.

copyOrWrap - COPY stores a safe, internal copy of the collection; WRAP stores a pointer to the original collection

Method Detail

getList

protected final ArrayList<E> getList()

Prepare the list of the right type for use a subclass. Implement e.g. as follows:

  @Override
 protected ArrayList<E> getList()
 {
     return (ArrayList<E>) super.getList();
 }
 

Overrides:

getList in class ImmutableAbstractList<E>

Returns:

the list of the right type for use a subclass

toList

public final List<E> toList()

Returns a modifiable copy of this immutable list.

Returns:

a modifiable copy of this immutable list.

subList

public final ImmutableList<E> subList(int fromIndex,
                                      int toIndex)

Returns a safe, immutable copy of the portion of this immutable list between the specified fromIndex, inclusive, and toIndex, exclusive. (If fromIndex and toIndex are equal, the returned immutable list is empty).

Parameters:

fromIndex - low endpoint (inclusive) of the subList

toIndex - high endpoint (exclusive) of the subList

Returns:

a view of the specified range within this immutable list

toString

public final String toString()

Overrides:

toString in class ImmutableAbstractList<E>