cat.inspiracio.util

Class BagMap<K extends Serializable,V extends Serializable>

java.lang.Object

cat.inspiracio.util.BagMap<K,V>

All Implemented Interfaces:

Serializable, Iterable<Map.Entry<K,V>>

Direct Known Subclasses:

URLParameters

public class BagMap<K extends Serializable,V extends Serializable>
extends Object
implements Iterable<Map.Entry<K,V>>, Serializable

Like a map, but entries conserve their order and there may be several entries with the same key. A value cannot be null. Keys and values have to serialisable, because I am interested in serialisable things.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BagMap() Makes a new empty bag map.

Method Summary

Methods

Modifier and Type	Method and Description
BagMap<K,V>	add(K key, V value) Adds an entry.
boolean	containsKey(K key) Is there an entry with this key?
boolean	empty()
Collection<Map.Entry<K,V>>	entries() All entries.
V	get(K key) Gets the value of the first entry with that key, or null if there is none.
List<V>	getValues(K key) Gets all the values for a key, in the order that they were inserted.
boolean	isEmpty()
Iterable<Map.Entry<K,V>>	iteratable() All the entries in the order they were inserted.
Iterator<Map.Entry<K,V>>	iterator() All the entries in the order they were inserted.
Collection<K>	keys() All keys that have a value.
void	remove(K key) Removes all entries with this key.
void	set(K key, V value) Sets the first entry with this key to this value and removes all the others.
Collection<V>	values() All values.

Methods inherited from class java.lang.Object

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

Constructor Detail

BagMap

public BagMap()

Makes a new empty bag map.

Method Detail

add

public BagMap<K,V> add(K key,
              V value)

Adds an entry. If the value is null, removes the parameter. Returns this, for fluid style.

get

public V get(K key)

Gets the value of the first entry with that key, or null if there is none.

getValues

public List<V> getValues(K key)

Gets all the values for a key, in the order that they were inserted. Returns a fresh list.

containsKey

public boolean containsKey(K key)

Is there an entry with this key?

remove

public void remove(K key)

Removes all entries with this key.

set

public void set(K key,
       V value)

Sets the first entry with this key to this value and removes all the others. If there is no such entry, adds one. Setting a value to null is removing all.

isEmpty

public boolean isEmpty()

empty

public boolean empty()

iterator

public Iterator<Map.Entry<K,V>> iterator()

All the entries in the order they were inserted.

Specified by:

iterator in interface Iterable<Map.Entry<K extends Serializable,V extends Serializable>>

iteratable

public Iterable<Map.Entry<K,V>> iteratable()

All the entries in the order they were inserted.

keys

public Collection<K> keys()

All keys that have a value.

values

public Collection<V> values()

All values.

entries

public Collection<Map.Entry<K,V>> entries()

All entries.