Oracle® Coherence Java API Reference
v3.5.3

E15583-01

com.tangosol.util
Class ImmutableMultiList

java.lang.Object
  extended by java.util.AbstractCollection
      extended by java.util.AbstractList
          extended by com.tangosol.util.ImmutableMultiList
All Implemented Interfaces:
java.lang.Iterable, java.util.Collection, java.util.List, java.util.Set

public class ImmutableMultiList
extends java.util.AbstractList
implements java.util.List, java.util.Set

Implementation of the List interface in a read-only fashion based on a collection of arrays.

This class also implements the Set interface, although the contents are not checked to determine whether each element is unique. It is the responsibility of the user to ensure that the elements are unique if the object is used as a Set.

Author:
gg 2009.1.20
See Also:
ImmutableArrayList

Field Summary
 
Fields inherited from class java.util.AbstractList
modCount
 
Constructor Summary
ImmutableMultiList(java.util.Collection collection)
          Construct a List containing the elements of the specified Collection of Object arrays.
ImmutableMultiList(java.lang.Object[][] aao)
          Construct a List containing the elements of the specified array of Object arrays.
 
Method Summary
static int calculateTotalLength(java.lang.Object[][] aao)
          Calculate the total number of element in the array of arrays.
 boolean contains(java.lang.Object o)
          Returns true if this List contains the specified element.
protected  ImmutableArrayList ensureFlattened()
          Flatten the multi array into a single array.
 boolean equals(java.lang.Object o)
          Compare this Collection / List / Set with some other Object and determine if the caller would believe this Object to equal that other Object.
static java.lang.Object[] flatten(java.lang.Object[][] aaoFrom, int cTotal, java.lang.Object[] aoTo)
          Create a single dimensional array containing all elements of the specified array of arrays.
 java.lang.Object get(int i)
          Returns the element at the specified position in this List.
 int indexOf(java.lang.Object o)
          Returns the index in this List of the first occurrence of the specified element, or -1 if this List does not contain this element.
 java.util.Iterator iterator()
          Returns an iterator over the elements in this list in proper sequence.
 int lastIndexOf(java.lang.Object o)
          Returns the index in this List of the last occurrence of the specified element, or -1 if this List does not contain this element.
 int size()
          Returns the number of elements in this List.
 java.lang.Object[] toArray()
          Returns an array containing all of the elements in this List in the order that the elements occur in the List.
 java.lang.Object[] toArray(java.lang.Object[] ao)
          Returns an array with ao runtime type is that of the specified array and that contains all of the elements in this List.
 
Methods inherited from class java.util.AbstractList
add, add, addAll, clear, hashCode, listIterator, listIterator, remove, removeRange, set, subList
 
Methods inherited from class java.util.AbstractCollection
addAll, containsAll, isEmpty, remove, removeAll, retainAll, toString
 
Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, containsAll, hashCode, isEmpty, listIterator, listIterator, remove, remove, removeAll, retainAll, set, subList
 
Methods inherited from interface java.util.Set
add, addAll, clear, containsAll, hashCode, isEmpty, remove, removeAll, retainAll
 

Constructor Detail

ImmutableMultiList

public ImmutableMultiList(java.lang.Object[][] aao)
Construct a List containing the elements of the specified array of Object arrays.

Parameters:
aao - the array of arrays to fill this MultiList from

ImmutableMultiList

public ImmutableMultiList(java.util.Collection collection)
Construct a List containing the elements of the specified Collection of Object arrays.

Parameters:
collection - the Collection of arrays to fill this MultiList from
Method Detail

size

public int size()
Returns the number of elements in this List.

Specified by:
size in interface java.util.Collection
Specified by:
size in interface java.util.List
Specified by:
size in interface java.util.Set
Specified by:
size in class java.util.AbstractCollection
Returns:
the number of elements in this List

get

public java.lang.Object get(int i)
Returns the element at the specified position in this List.

Specified by:
get in interface java.util.List
Specified by:
get in class java.util.AbstractList
Parameters:
i - the index of the element to return
Returns:
the element at the specified position in this List
Throws:
java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).

indexOf

public int indexOf(java.lang.Object o)
Returns the index in this List of the first occurrence of the specified element, or -1 if this List does not contain this element. More formally, returns the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

Specified by:
indexOf in interface java.util.List
Overrides:
indexOf in class java.util.AbstractList
Parameters:
o - element to search for.
Returns:
the index in this List of the first occurrence of the specified element, or -1 if this List does not contain this element.

lastIndexOf

public int lastIndexOf(java.lang.Object o)
Returns the index in this List of the last occurrence of the specified element, or -1 if this List does not contain this element. More formally, returns the highest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

Specified by:
lastIndexOf in interface java.util.List
Overrides:
lastIndexOf in class java.util.AbstractList
Parameters:
o - element to search for.
Returns:
the index in this List of the last occurrence of the specified element, or -1 if this List does not contain this element.

contains

public boolean contains(java.lang.Object o)
Returns true if this List contains the specified element. More formally, returns true if and only if this List contains at least one element e such that (o==null ? e==null : o.equals(e)).

Specified by:
contains in interface java.util.Collection
Specified by:
contains in interface java.util.List
Specified by:
contains in interface java.util.Set
Overrides:
contains in class java.util.AbstractCollection
Parameters:
o - element whose presence in this List is to be tested
Returns:
true if this List contains the specified element

toArray

public java.lang.Object[] toArray()
Returns an array containing all of the elements in this List in the order that the elements occur in the List. The returned array will be "safe" in that no references to it are maintained by the List. The caller is thus free to modify the returned array.

Specified by:
toArray in interface java.util.Collection
Specified by:
toArray in interface java.util.List
Specified by:
toArray in interface java.util.Set
Overrides:
toArray in class java.util.AbstractCollection
Returns:
an array containing all of the elements in this List

toArray

public java.lang.Object[] toArray(java.lang.Object[] ao)
Returns an array with ao runtime type is that of the specified array and that contains all of the elements in this List. If the elements all fit in the specified array, it is returned therein. Otherwise, ao new array is allocated with the runtime type of the specified array and the size of this List.

If the elements of the MultiList fit in the specified array with room to spare (i.e., the array has more elements than the MultuList), the element in the array immediately following the end of the last element is set to null.

Specified by:
toArray in interface java.util.Collection
Specified by:
toArray in interface java.util.List
Specified by:
toArray in interface java.util.Set
Overrides:
toArray in class java.util.AbstractCollection
Parameters:
ao - the array into which the elements of the MultiList are to be stored, if it is big enough; otherwise, ao new array of the same runtime type is allocated for this purpose
Returns:
an array containing all the elements of the MultiList
Throws:
java.lang.ArrayStoreException - if the runtime type of the specified array is not ao supertype of the runtime type of every element in this MultiList

iterator

public java.util.Iterator iterator()
Returns an iterator over the elements in this list in proper sequence.

Specified by:
iterator in interface java.lang.Iterable
Specified by:
iterator in interface java.util.Collection
Specified by:
iterator in interface java.util.List
Specified by:
iterator in interface java.util.Set
Overrides:
iterator in class java.util.AbstractList
Returns:
an iterator over the elements in this list in proper sequence.

equals

public boolean equals(java.lang.Object o)
Compare this Collection / List / Set with some other Object and determine if the caller would believe this Object to equal that other Object.

Specified by:
equals in interface java.util.Collection
Specified by:
equals in interface java.util.List
Specified by:
equals in interface java.util.Set
Overrides:
equals in class java.util.AbstractList
Parameters:
o - some other Object that is likely to be a Collection or some more specific type (with its related overloaded definition of what it thinks that equals() means)
Returns:
true iff this Object believes that it can make a defensible case that this Object is equal to the passed Object

ensureFlattened

protected ImmutableArrayList ensureFlattened()
Flatten the multi array into a single array. This could be a necessary de-optimization for implementing Set operations such as contains() and indexOf().

Returns:
an ImmutableArrayList b ased on a flattened array

calculateTotalLength

public static int calculateTotalLength(java.lang.Object[][] aao)
Calculate the total number of element in the array of arrays.

Parameters:
aao - an array of arrays
Returns:
the total number of elements

flatten

public static java.lang.Object[] flatten(java.lang.Object[][] aaoFrom,
                                         int cTotal,
                                         java.lang.Object[] aoTo)
Create a single dimensional array containing all elements of the specified array of arrays.

Parameters:
aaoFrom - an array of arrays to copy from
cTotal - the total length of the flattened array; pass -1 for it to be calculated
aoTo - an array to copy the elements into (optional)
Returns:
an array containing all the elements of the array of arrays
Throws:
java.lang.ArrayIndexOutOfBoundsException - if the total length parameter was not sufficient to hold the flattened array

Oracle® Coherence Java API Reference
v3.5.3

E15583-01

Copyright © 2000, 2010, Oracle. All rights reserved.