com.endeca.navigation
Class ERecSearchKeyList

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractList
          com.endeca.navigation.ERecSearchKeyList

All Implemented Interfaces:

Iterable, Collection, List

public class ERecSearchKeyList
extends AbstractList
implements List

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

Note: ERecSearchKeyList 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 record search key at offset index.
ERecSearchKey	getKey(int index) Gets record search key at offset index.
ERecSearchKey	getKey(String name) Gets record search key with the name name.
int	size() Gets the number of record search keys.

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

getKey

public ERecSearchKey getKey(int index)

Gets record search 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.

Parameters:

index - Index into list.

Returns:

record search key at offset index.

Throws:

IndexOutOfBoundsException - if index is out of range.

get

public Object get(int index)

Gets record search key at offset index. Object is of type ERecSearchKey. Will throw an IndexOutOfBound exception if offset is not legal.

Specified by:

get in interface List

Specified by:

get in class AbstractList

Parameters:

index - Index into list.

Returns:

record search key at offset index.

Throws:

IndexOutOfBoundsException - if index is out of range.

size

public int size()

Gets the number of record search keys.

Specified by:

size in interface Collection

Specified by:

size in interface List

Specified by:

size in class AbstractCollection

Returns:

Number of record search keys.

getKey

public ERecSearchKey getKey(String name)

Gets record search key with the name name.

Returns:

retuns the record search key specified with name. Returns null if key could with specified name could not be found.