com.groiss.ds
Class KeyedList

java.lang.Object
  com.groiss.ds.KeyedList

All Implemented Interfaces:

java.lang.Iterable, java.util.Collection, java.util.List

public class KeyedList
extends java.lang.Object
implements java.util.List

This class implements an ordered map. A list of keys is mapped to a list of values. The values can be accessed by the key or the position in the list.

Constructor Summary

KeyedList()

KeyedList(java.util.List keys, java.util.List content)
Create a new KeyedList.

Method Summary

void	add(int pos, java.lang.Object o)
boolean	add(java.lang.Object o)
boolean	addAll(java.util.Collection c)
boolean	addAll(int i, java.util.Collection c)
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection c)
java.lang.Object	get(int pos)
java.lang.Object	get(java.lang.Object key) Get the object mapped to the given key.
java.lang.Object	getKey(int i) Returns the key a postion i
int	getKey(java.lang.Object key) Return the position of the given key in the key list.
int	indexOf(java.lang.Object o)
boolean	isEmpty()
java.util.Iterator	iterator()
int	lastIndexOf(java.lang.Object o)
java.util.ListIterator	listIterator()
java.util.ListIterator	listIterator(int i)
void	put(int pos, java.lang.Object key, java.lang.Object elem) Put an element at position.
void	put(java.lang.Object key, java.lang.Object elem) Put an element to the end of the list.
java.lang.Object	remove(int pos)
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection c)
boolean	removeKey(java.lang.Object key) Removes the key (and associated object) from the list
boolean	retainAll(java.util.Collection c)
java.lang.Object	set(int i, java.lang.Object o)
void	set(java.lang.Object key, java.lang.Object elem) Replace the element mapped to key with the given element.
int	size()
java.util.List	subList(int fromIndex, int toIndex)
java.lang.Object[]	toArray()
java.lang.Object[]	toArray(java.lang.Object[] arr)
java.util.List	values() Return the content list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.List

equals, hashCode

Constructor Detail

KeyedList

public KeyedList()

KeyedList

public KeyedList(java.util.List keys,
                 java.util.List content)

Create a new KeyedList.

Parameters:

keys -

content -

Method Detail

put

public void put(java.lang.Object key,
                java.lang.Object elem)

Put an element to the end of the list.

Parameters:

key - a key

elem - an element

put

public void put(int pos,
                java.lang.Object key,
                java.lang.Object elem)

Put an element at position.

Parameters:

pos - insert after this position

key - a key

elem - an element

get

public java.lang.Object get(java.lang.Object key)

Get the object mapped to the given key.

Parameters:

key -

Returns:

the object for this key, null if key not bound to an object

set

public void set(java.lang.Object key,
                java.lang.Object elem)

Replace the element mapped to key with the given element.

Parameters:

key -

elem -

values

public java.util.List values()

Return the content list.

Returns:

the content.

getKey

public java.lang.Object getKey(int i)

Returns the key a postion i

Parameters:

i - the position

Returns:

the key a position i

getKey

public int getKey(java.lang.Object key)

Return the position of the given key in the key list.

Parameters:

key -

Returns:

the position of the key, -1 if not in keys

removeKey

public boolean removeKey(java.lang.Object key)

Removes the key (and associated object) from the list

Parameters:

key -

Returns:

true it the key was in the list

size

public int size()

Specified by:

size in interface java.util.Collection

Specified by:

size in interface java.util.List

clear

public void clear()

Specified by:

clear in interface java.util.Collection

Specified by:

clear in interface java.util.List

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection

Specified by:

isEmpty in interface java.util.List

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection

Specified by:

toArray in interface java.util.List

get

public java.lang.Object get(int pos)

Specified by:

get in interface java.util.List

remove

public java.lang.Object remove(int pos)

Specified by:

remove in interface java.util.List

add

public void add(int pos,
                java.lang.Object o)

Specified by:

add in interface java.util.List

indexOf

public int indexOf(java.lang.Object o)

Specified by:

indexOf in interface java.util.List

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Specified by:

lastIndexOf in interface java.util.List

add

public boolean add(java.lang.Object o)

Specified by:

add in interface java.util.Collection

Specified by:

add in interface java.util.List

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection

Specified by:

contains in interface java.util.List

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection

Specified by:

remove in interface java.util.List

addAll

public boolean addAll(int i,
                      java.util.Collection c)

Specified by:

addAll in interface java.util.List

addAll

public boolean addAll(java.util.Collection c)

Specified by:

addAll in interface java.util.Collection

Specified by:

addAll in interface java.util.List

containsAll

public boolean containsAll(java.util.Collection c)

Specified by:

containsAll in interface java.util.Collection

Specified by:

containsAll in interface java.util.List

removeAll

public boolean removeAll(java.util.Collection c)

Specified by:

removeAll in interface java.util.Collection

Specified by:

removeAll in interface java.util.List

retainAll

public boolean retainAll(java.util.Collection c)

Specified by:

retainAll in interface java.util.Collection

Specified by:

retainAll in interface java.util.List

iterator

public java.util.Iterator iterator()

Specified by:

iterator in interface java.lang.Iterable

Specified by:

iterator in interface java.util.Collection

Specified by:

iterator in interface java.util.List

subList

public java.util.List subList(int fromIndex,
                              int toIndex)

Specified by:

subList in interface java.util.List

listIterator

public java.util.ListIterator listIterator()

Specified by:

listIterator in interface java.util.List

listIterator

public java.util.ListIterator listIterator(int i)

Specified by:

listIterator in interface java.util.List

set

public java.lang.Object set(int i,
                            java.lang.Object o)

Specified by:

set in interface java.util.List

toArray

public java.lang.Object[] toArray(java.lang.Object[] arr)

Specified by:

toArray in interface java.util.Collection

Specified by:

toArray in interface java.util.List