com.groiss.ds

Class KeyedList<K,V>

java.lang.Object

com.groiss.ds.KeyedList<K,V>

All Implemented Interfaces:

Iterable<V>, Collection<V>, List<V>

public class KeyedList<K,V>
extends Object
implements List<V>

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

Constructors

Constructor and Description
KeyedList()
KeyedList(List<K> keys, List<V> content) Create a new KeyedList.

Method Summary

Modifier and Type	Method and Description
void	add(int pos, V o)
boolean	add(V o) Caution: This method destroys the one-to-one relation between keys and content!
boolean	addAll(Collection<? extends V> c) Caution: This method destroys the one-to-one relation between keys and content!
boolean	addAll(int i, Collection<? extends V> c) Caution: This method destroys the one-to-one relation between keys and content!
boolean	addAll(KeyedList<K,V> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
V	get(int pos)
V	get(Object key) Get the object mapped to the given key.
K	getKey(int i) Returns the key a postion i
int	getKey(Object key) Return the position of the given key in the key list.
Iterator<K>	getKeyIterator() Returns an iterator for the key list
List<K>	getKeys()
int	indexOf(Object o)
boolean	isEmpty()
Iterator<V>	iterator()
int	lastIndexOf(Object o)
ListIterator<V>	listIterator()
ListIterator<V>	listIterator(int i)
void	put(int pos, K key, V elem) Put an element at position.
void	put(K key, V elem) Put an element to the end of the list.
V	remove(int pos)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	removeKey(Object key) Removes the key (and associated object) from the list
boolean	retainAll(Collection<?> c)
V	set(int i, V o)
void	set(K key, V elem) Replace the element mapped to key with the given element.
int	size()
List<V>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T> T[]	toArray(T[] a)
List<V>	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, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

KeyedList

public KeyedList()

KeyedList

public KeyedList(List<K> keys,
                 List<V> content)

Create a new KeyedList.

Parameters:

keys -

content -

Method Detail

put

public void put(K key,
                V elem)

Put an element to the end of the list.

Parameters:

key - a key

elem - an element

put

public void put(int pos,
                K key,
                V elem)

Put an element at position.

Parameters:

pos - insert after this position

key - a key

elem - an element

get

public V get(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(K key,
                V elem)

Replace the element mapped to key with the given element.

Parameters:

key -

elem -

values

public List<V> values()

Return the content list.

Returns:

the content.

getKey

public K getKey(int i)

Returns the key a postion i

Parameters:

i - the position

Returns:

the key a position i

getKeyIterator

public Iterator<K> getKeyIterator()

Returns an iterator for the key list

Returns:

an iterotor over key

getKeys

public List<K> getKeys()

getKey

public int getKey(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(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 Collection<V>

Specified by:

size in interface List<V>

clear

public void clear()

Specified by:

clear in interface Collection<V>

Specified by:

clear in interface List<V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<V>

Specified by:

isEmpty in interface List<V>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<V>

Specified by:

toArray in interface List<V>

get

public V get(int pos)

Specified by:

get in interface List<V>

remove

public V remove(int pos)

Specified by:

remove in interface List<V>

add

public void add(int pos,
                V o)

Specified by:

add in interface List<V>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<V>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<V>

add

public boolean add(V o)

Caution: This method destroys the one-to-one relation between keys and content! It manipulates only the content.

Specified by:

add in interface Collection<V>

Specified by:

add in interface List<V>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<V>

Specified by:

contains in interface List<V>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<V>

Specified by:

remove in interface List<V>

addAll

public boolean addAll(int i,
                      Collection<? extends V> c)

Caution: This method destroys the one-to-one relation between keys and content! It manipulates only the content.

Specified by:

addAll in interface List<V>

addAll

public boolean addAll(Collection<? extends V> c)

Caution: This method destroys the one-to-one relation between keys and content! It manipulates only the content.

Specified by:

addAll in interface Collection<V>

Specified by:

addAll in interface List<V>

addAll

public boolean addAll(KeyedList<K,V> c)

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<V>

Specified by:

containsAll in interface List<V>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<V>

Specified by:

removeAll in interface List<V>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<V>

Specified by:

retainAll in interface List<V>

iterator

public Iterator<V> iterator()

Specified by:

iterator in interface Iterable<V>

Specified by:

iterator in interface Collection<V>

Specified by:

iterator in interface List<V>

subList

public List<V> subList(int fromIndex,
                       int toIndex)

Specified by:

subList in interface List<V>

listIterator

public ListIterator<V> listIterator()

Specified by:

listIterator in interface List<V>

listIterator

public ListIterator<V> listIterator(int i)

Specified by:

listIterator in interface List<V>

set

public V set(int i,
             V o)

Specified by:

set in interface List<V>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<V>

Specified by:

toArray in interface List<V>