Package org.fugerit.java.core.util.collection

Class ListMap<K,T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<T>

org.fugerit.java.core.util.collection.ListMap<K,T>

Type Parameters:

K - the class type for the key

T - the class type for the value

All Implemented Interfaces:

Serializable, Iterable<T>, Collection<T>, List<T>

Direct Known Subclasses:

ListMapStringKey

public class ListMap<K,T>
extends AbstractList<T>
implements Serializable

A implementation of java.util.List interface able to save a collections in a Map too.

Author:

Fugerit

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	ADD_MODE_DEFAULT
static int	ADD_MODE_LOOSE
static int	ADD_MODE_STRICT

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
ListMap()	Default constructor, create an Empty ListMap
ListMap(int addMode)
ListMap(KeyMapper<K,T> keyMapper)
ListMap(KeyMapper<K,T> keyMapper, int addMode)

Method Summary

Modifier and Type	Method	Description
void	add(int index, T element)
T	get(int index)
T	get(Object key)	Get an object by key Delegate for getMap().get().
int	getAddMode()	Get the object adding policy for this List.
Iterator<K>	getKeyIterator()	Return iteration over Keys
KeyMapper<K,T>	getKeyMapper()	Get the KeyMapper for this ListMap
Map<K,T>	getMap()	The list underlying Map
T	getProperty(K key)	Alias for get(key)
T	remove(int index)
T	set(int index, T element)
void	setAddMode(int addMode)	Set the object adding policy for this List ListMap has an underlying Map, the policy states of duplicate keys are allowed
void	setKeyMapper(KeyMapper<K,T> keyMapper)	Set the KeyMapper for this ListMap
int	size()

Methods inherited from class java.util.AbstractList

add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Field Detail

ADD_MODE_STRICT

public static final int ADD_MODE_STRICT

See Also:

Constant Field Values

ADD_MODE_LOOSE

public static final int ADD_MODE_LOOSE

See Also:

Constant Field Values

ADD_MODE_DEFAULT

public static final int ADD_MODE_DEFAULT

See Also:

Constant Field Values

Constructor Detail

ListMap

public ListMap(KeyMapper<K,T> keyMapper,
               int addMode)

ListMap

public ListMap(KeyMapper<K,T> keyMapper)

ListMap

public ListMap(int addMode)

ListMap

public ListMap()

Default constructor, create an Empty ListMap

Method Detail

getKeyMapper

public KeyMapper<K,T> getKeyMapper()

Get the KeyMapper for this ListMap

Returns:

the KeyMapper

setKeyMapper

public void setKeyMapper(KeyMapper<K,T> keyMapper)

Set the KeyMapper for this ListMap

Parameters:

keyMapper - the KeyMapper

add

public void add(int index,
                T element)

Specified by:

add in interface List<K>

Overrides:

add in class AbstractList<T>

remove

public T remove(int index)

Specified by:

remove in interface List<K>

Overrides:

remove in class AbstractList<T>

set

public T set(int index,
             T element)

Specified by:

set in interface List<K>

Overrides:

set in class AbstractList<T>

get

public T get(int index)

Specified by:

get in interface List<K>

Specified by:

get in class AbstractList<T>

size

public int size()

Specified by:

size in interface Collection<K>

Specified by:

size in interface List<K>

Specified by:

size in class AbstractCollection<T>

get

public T get(Object key)

Get an object by key Delegate for getMap().get().

Parameters:

key - the key

Returns:

the value

getProperty

public T getProperty(K key)

Alias for get(key)

Parameters:

key - the key

Returns:

the value

getKeyIterator

public Iterator<K> getKeyIterator()

Return iteration over Keys

Returns:

iterations over keys

getMap

public Map<K,T> getMap()

The list underlying Map

Returns:

The key/value Map for this ListMap

getAddMode

public int getAddMode()

Get the object adding policy for this List.

Returns:

the AddMode

setAddMode

public void setAddMode(int addMode)

Set the object adding policy for this List ListMap has an underlying Map, the policy states of duplicate keys are allowed

Parameters:

addMode - the policy