ImmutableVector (Open Traffic Sim demo classes 0.12.02 API)

java.lang.Object
- org.opentrafficsim.base.immutablecollections.ImmutableAbstractList<E>
- - org.opentrafficsim.base.immutablecollections.ImmutableVector<E>

Type Parameters:

E - the type of content of this List

All Implemented Interfaces:

Serializable, Iterable<E>, RandomAccess, ImmutableCollection<E>, ImmutableList<E>
```
public class ImmutableVector<E>
extends ImmutableAbstractList<E>
```
An immutable wrapper for a Vector.
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
`ImmutableVector(ImmutableList<E> list)`
`ImmutableVector(ImmutableList<E> list, Immutable copyOrWrap)`
`ImmutableVector(List<E> list)`
`ImmutableVector(List<E> list, Immutable copyOrWrap)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`capacity()` Returns the current capacity of this immutable vector.
`void`	`copyInto(Object[] anArray)` Copies the components of this immutable vector into the specified array.
`E`	`elementAt(int index)` Returns the component at the specified index.
`Enumeration<E>`	`elements()` Returns an enumeration of the components of this vector.
`E`	`firstElement()` Returns the first component (the item at index `0`) of this immutable vector.
`protected Vector<E>`	`getList()` Prepare the list of the right type for use a subclass.
`int`	`indexOf(Object o, int index)` Returns the index of the first occurrence of the specified element in this immutable vector, searching forwards from `index`, or returns -1 if the element is not found.
`E`	`lastElement()` Returns the last component of the immutable vector.
`int`	`lastIndexOf(Object o, int index)` Returns the index of the last occurrence of the specified element in this immutable vector, searching backwards from `index`, or returns -1 if the element is not found.
`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
  - ImmutableVector
```
public ImmutableVector(List<E> list)
```
    Parameters:
    
    list - the list to use as the immutable list.
  - ImmutableVector
```
public ImmutableVector(List<E> list,
                       Immutable copyOrWrap)
```
    Parameters:
    
    list - the list to use as the immutable vector.
    
    copyOrWrap - COPY stores a safe, internal copy of the collection; WRAP stores a pointer to the original collection
  - ImmutableVector
```
public ImmutableVector(ImmutableList<E> list)
```
    Parameters:
    
    list - the list to use as the immutable list.
  - ImmutableVector
```
public ImmutableVector(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 Vector<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
  - copyInto
```
public final void copyInto(Object[] anArray)
```
    Copies the components of this immutable vector into the specified array. The item at index k in this immutable vector is copied into component k of anArray.
    
    Parameters:
    
    anArray - the array into which the components get copied
    
    Throws:
    
    NullPointerException - if the given array is null
    
    IndexOutOfBoundsException - if the specified array is not large enough to hold all the components of this immutable vector
    
    ArrayStoreException - if a component of this immutable vector is not of a runtime type that can be stored in the specified array
    
    See Also:
    
    ImmutableAbstractList.toArray(Object[])
  - capacity
```
public final int capacity()
```
    Returns the current capacity of this immutable vector.
    
    Returns:
    
    the current capacity of this immutable vector.
  - elements
```
public final Enumeration<E> elements()
```
    Returns an enumeration of the components of this vector. The returned Enumeration object will generate all items in this vector. The first item generated is the item at index 0, then the item at index 1, and so on.
    
    Returns:
    
    an enumeration of the components of this vector
    
    See Also:
    
    Iterator
  - indexOf
```
public final int indexOf(Object o,
                         int index)
```
    Returns the index of the first occurrence of the specified element in this immutable vector, searching forwards from index, or returns -1 if the element is not found. More formally, returns the lowest index i such that (i >= index && (o==null ? get(i)==null : o.equals(get(i)))), or -1 if there is no such index.
    
    Parameters:
    
    o - element to search for
    
    index - index to start searching from
    
    Returns:
    
    the index of the first occurrence of the element in this immutable vector at position index or later in the vector; -1 if the element is not found.
    
    Throws:
    
    IndexOutOfBoundsException - if the specified index is negative
    
    See Also:
    
    Object.equals(Object)
  - lastIndexOf
```
public final int lastIndexOf(Object o,
                             int index)
```
    Returns the index of the last occurrence of the specified element in this immutable vector, searching backwards from index, or returns -1 if the element is not found. More formally, returns the highest index i such that (i <= index && (o==null ? get(i)==null : o.equals(get(i)))), or -1 if there is no such index.
    
    Parameters:
    
    o - element to search for
    
    index - index to start searching backwards from
    
    Returns:
    
    the index of the last occurrence of the element at position less than or equal to index in this immutable vector; -1 if the element is not found.
    
    Throws:
    
    IndexOutOfBoundsException - if the specified index is greater than or equal to the current size of this immutable vector
  - elementAt
```
public final E elementAt(int index)
```
    Returns the component at the specified index.
    This method is identical in functionality to the ImmutableAbstractList.get(int) method (which is part of the List interface).
    
    Parameters:
    
    index - an index into this immutable vector
    
    Returns:
    
    the component at the specified index
    
    Throws:
    
    ArrayIndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())
  - firstElement
```
public final E firstElement()
```
    Returns the first component (the item at index 0) of this immutable vector.
    
    Returns:
    
    the first component of this immutable vector
    
    Throws:
    
    NoSuchElementException - if this immutable vector has no components
  - lastElement
```
public final E lastElement()
```
    Returns the last component of the immutable vector.
    
    Returns:
    
    the last component of the immutable vector, i.e., the component at index size() - 1.
    
    Throws:
    
    NoSuchElementException - if this immutable vector is empty
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class ImmutableAbstractList<E>

Class ImmutableVector<E>

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ImmutableVector

ImmutableVector

ImmutableVector

ImmutableVector

Method Detail

getList

toList

subList

copyInto

capacity

elements

indexOf

lastIndexOf

elementAt

firstElement

lastElement

toString