NamedList (olap4j 1.3.0 API)

All Superinterfaces:: Collection<E>, Iterable<E>, List<E>, SequencedCollection<E>

All Known Implementing Classes:: AbstractNamedList, ArrayNamedListImpl, NamedListImpl

public interface NamedList<E> extends List<E>

Extension to List which allows access to members of the list by name as well as by ordinal.

Since:: Aug 22, 2006
Author:: jhyde

Method Summary

Modifier and Type

Method

Description

Map<String,E>

asMap()

Returns a view of this named list as a Map whose key is the name of each element.

E

get(String name)

Retrieves a member by name.

String

getName(Object element)

Returns the name of a given element.

int

indexOfName(String name)

Returns the position where a member of a given name is found, or -1 if the member is not present.

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface java.util.List
add, add, addAll, addAll, addFirst, addLast, clear, contains, containsAll, equals, get, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, set, size, sort, spliterator, subList, toArray, toArray

Method Details
- get
  
  E get(String name)
  
  Retrieves a member by name.
  Parameters:
  
  name - name of the element to return
  
  Returns:
  
  the element of the list with the specified name, or null if there is no such element
  
  See Also:
  
  List.get(int)
- indexOfName
  
  int indexOfName(String name)
  
  Returns the position where a member of a given name is found, or -1 if the member is not present.
  Parameters:
  
  name - name of the element to return
  
  Returns:
  
  the index of element of the list with the specified name, or -1 if there is no such element
  
  See Also:
  
  List.indexOf(Object)
- getName
  
  String getName(Object element)
  
  Returns the name of a given element.
  
  Parameters:
  
  element - Element
  
  Returns:
  
  Name of element
- asMap
  
  Map<String,E> asMap()
  
  Returns a view of this named list as a Map whose key is the name of each element.
  
  Returns:
  
  A view of this named list as a map