com.github.jferard.fastods.util

Class Container<K,V>

java.lang.Object

com.github.jferard.fastods.util.Container<K,V>

Type Parameters:

K - key class

V - value class

public class Container<K,V>
extends Object

A Container is a Map like object, but with a mode parameter: one may create, update, or create or update a key-value pair. The container may be frozen: no new key-value pair is accepted.

Author:

Julien Férard

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Container.Mode the mode

Constructor Summary

Constructors

Constructor and Description
Container(Logger logger) Builds a default container

Method Summary

Modifier and Type	Method and Description
boolean	add(K key, V value) If mode is update, then the key must exist.
void	debug() Set the debug mode: every add will be stored
void	freeze() Freeze the container: no new key-value pair is accepted.
V	get(K key)
Map<K,V>	getValueByKey()
Iterable<V>	getValues()
void	setMode(Container.Mode mode) Set the new mode to use

Methods inherited from class java.lang.Object

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

Constructor Detail

Container

public Container(Logger logger)

Builds a default container

Parameters:

logger - the logger

Method Detail

setMode

public void setMode(Container.Mode mode)

Set the new mode to use

Parameters:

mode - the mode (CREATE, UPDATE, CREATE_OR_UPDATE)

add

public boolean add(K key,
                   V value)

If mode is update, then the key must exist. If the mode is create, then the key must not exist. Otherwise, the key may exist. If the container is frozen, no new key-value pair is accepted.

Parameters:

key - the key

value - the value

Returns:

true if the value was updated

debug

public void debug()

Set the debug mode: every add will be stored

freeze

public void freeze()

Freeze the container: no new key-value pair is accepted.

get

public V get(K key)

Parameters:

key - the key to look for

Returns:

the value mapped to the key

getValueByKey

public Map<K,V> getValueByKey()

Returns:

the container as a Map

getValues

public Iterable<V> getValues()

Returns:

the values