com.endeca.navigation
Class ERecRollupKeyList

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractList
          extended by com.endeca.navigation.ERecRollupKeyList
All Implemented Interfaces:
Iterable, Collection, List

public class ERecRollupKeyList
extends AbstractList
implements List

Collection of record rollup keys exposed as a java.util.List.

Note: ERecRollupKeyList objects are unmodifiable and therefore do not support any modification operations (such as add, remove, and clear) that are inherited. Attempting to modify the object may result in a runtime exception (UnsupportedOperationException).


Field Summary
 
Fields inherited from class java.util.AbstractList
modCount
 
Method Summary
 Object get(int index)
          Gets rollup key at offset index.
 ERecRollupKey getKey(int index)
          Gets rollup key at offset index.
 ERecRollupKey getKey(String name)
          Gets rollup key with the name name.
 int size()
          Gets the size of lists or the number of rollup keys in this list.
 
Methods inherited from class java.util.AbstractList
add, add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList
 
Methods inherited from class java.util.AbstractCollection
addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, contains, containsAll, equals, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, subList, toArray, toArray
 

Method Detail

get

public Object get(int index)
Gets rollup key at offset index. Will throw an IndexOutOfBound exception if offset is not legal. Type of object returned is ERecRollupKey.

Specified by:
get in interface List
Specified by:
get in class AbstractList
Returns:
rollup key at offset index.
Throws:
IndexOutOfBoundsException - if index is out of range.

size

public int size()
Gets the size of lists or the number of rollup keys in this list.

Specified by:
size in interface Collection
Specified by:
size in interface List
Specified by:
size in class AbstractCollection
Returns:
Size of this list.

getKey

public ERecRollupKey getKey(int index)
Gets rollup key at offset index. Typed version of the method get(index) from the List interface. Will throw an IndexOutOfBound exception if offset is not legal.

Returns:
rollup key at offset index.
Throws:
IndexOutOfBoundsException - if index is out of range.

getKey

public ERecRollupKey getKey(String name)
Gets rollup key with the name name.

Returns:
retuns the rollup key specified with name. Returns null if key could with specified name could not be found.


2010 Endeca Technologies, Inc.
Endeca Confidential