com.github.jferard.fastods.util

Class MultiContainer<K,S extends Enum<S>,V>

java.lang.Object

com.github.jferard.fastods.util.MultiContainer<K,S,V>

Type Parameters:

K - the key type

V - the value type

S - an enum of sub containers

public class MultiContainer<K,S extends Enum<S>,V>
extends Object

A multi container contains values indexed by sub container. The sub container is a value inside an enum. Basically, we have a map (K,S) to V.

Author:

Julien Férard

See Also:

for an example.

Constructor Summary

Constructors

Constructor and Description
MultiContainer(Logger logger, Class<S> subContainersEnum) Create a new multi container

Method Summary

Modifier and Type	Method and Description
boolean	add(K key, S subContainer, V value) Add a value to this multi container
void	debug() Enable debug mode
void	freeze() Freeze the container: no more add is allowed
V	get(K key, S subContainer)
Map<K,V>	getValueByKey(S subContainer)
Iterable<V>	getValues(S subContainer)
void	setMode(Container.Mode mode) Set the new mode to use
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiContainer

public MultiContainer(Logger logger,
                      Class<S> subContainersEnum)

Create a new multi container

Parameters:

logger - the logger

subContainersEnum - the enum

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,
                   S subContainer,
                   V value)

Add a value to this multi container

Parameters:

key - the key

subContainer - the sub container

value - the value

Returns:

true

get

public V get(K key,
             S subContainer)

Parameters:

key - the key

subContainer - the sub container

Returns:

the value, null if none

debug

public void debug()

Enable debug mode

freeze

public void freeze()

Freeze the container: no more add is allowed

getValueByKey

public Map<K,V> getValueByKey(S subContainer)

Parameters:

subContainer - the sub container

Returns:

a map K to V for the given container

getValues

public Iterable<V> getValues(S subContainer)

Parameters:

subContainer - the sub container

Returns:

all the values

toString

public String toString()

Overrides:

toString in class Object