com.exalead.papi.helper

Class KeyValuesContainer<Type1,Type2>

java.lang.Object

com.exalead.papi.helper.KeyValuesContainer<Type1,Type2>

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<java.util.Map.Entry<Type1,java.util.List<Type2>>>

public class KeyValuesContainer<Type1,Type2>
extends java.lang.Object
implements java.lang.Iterable<java.util.Map.Entry<Type1,java.util.List<Type2>>>, java.io.Serializable

Multi-purpose key / value container.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KeyValuesContainer() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addKeyValue(Type1 key, Type2 value) Append a new value to a given key.
void	addKeyValues(Type1 key, java.util.List<Type2> values) Appends new values to a given key.
Type2	getFirstValue(Type1 key) Get the first value of a given key.
java.util.List<Type2>	getValues(Type1 key) Lists the values of a given key.
java.util.Iterator<java.util.Map.Entry<Type1,java.util.List<Type2>>>	iterator() Gets an iterator for this collection.
void	setKeyValue(Type1 key, Type2 value) Sets the value of a given key.
void	setKeyValues(Type1 key, java.util.List<Type2> values) Sets the values of a given key.
int	size()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

KeyValuesContainer

public KeyValuesContainer()

Constructor.

Method Detail

setKeyValues

public void setKeyValues(Type1 key,
                         java.util.List<Type2> values)

Sets the values of a given key. Replaces existing values if any.

Parameters:

key - the key

values - the set of values to be associated with the specified key

setKeyValue

public void setKeyValue(Type1 key,
                        Type2 value)

Sets the value of a given key. Replaces existing values if any.

Parameters:

key - the key

value - the value to be associated with the specified key

addKeyValues

public void addKeyValues(Type1 key,
                         java.util.List<Type2> values)

Appends new values to a given key. If the key does not exist, it is automatically created.

Parameters:

key - the key

values - the values to be appended

addKeyValue

public void addKeyValue(Type1 key,
                        Type2 value)

Append a new value to a given key. If the key does not exist, it is automatically created.

Parameters:

key - the key

value - the value to be appended

getValues

public java.util.List<Type2> getValues(Type1 key)

Lists the values of a given key.

Parameters:

key - the key

Returns:

a list of values or null if the key does not exist.

getFirstValue

public Type2 getFirstValue(Type1 key)

Get the first value of a given key.

Parameters:

key - the key

Returns:

the first value of the key or null if the key does not exist or if it has no value

iterator

public java.util.Iterator<java.util.Map.Entry<Type1,java.util.List<Type2>>> iterator()

Gets an iterator for this collection.

Specified by:

iterator in interface java.lang.Iterable<java.util.Map.Entry<Type1,java.util.List<Type2>>>

Returns:

an iterator over the collection

size

public int size()

Returns:

The number of entries in the container