sirius.db.mixing.types

Class StringListMap

java.lang.Object

sirius.db.mixing.types.SafeMap<String,List<String>>

sirius.db.mixing.types.StringListMap

All Implemented Interfaces:

Iterable<Map.Entry<String,List<String>>>

public class StringListMap
extends SafeMap<String,List<String>>

Provides a map of string to list of strings as property value.

Field Summary

Fields inherited from class sirius.db.mixing.types.SafeMap

data

Constructor Summary

Constructors

Constructor and Description
StringListMap()

Method Summary

Modifier and Type	Method and Description
StringListMap	add(String key, String value) Adds the given value to the list of the given key.
StringListMap	addToSet(String key, String value) Adds the given value to the list of the given key.
StringListMap	clear(String key) Clears the list for the given key.
boolean	contains(String key, String value) Determines if the list stored for key contains the given value.
protected List<String>	copyValue(List<String> value) Creates a copy of the given value.
List<String>	getList(String key) Returns the list associated with the given key.
StringListMap	remove(String key, String value) Removes the given value from the given list.
protected boolean	valueNeedsCopy() Determines if values in this map must be copied if the map is copied.

Methods inherited from class sirius.db.mixing.types.SafeMap

clear, containsKey, copyMap, data, equals, forEach, get, hashCode, isEmpty, isFilled, iterator, modify, original, put, setData, size, spliterator

Methods inherited from class java.lang.Object

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

Constructor Detail

StringListMap

public StringListMap()

Method Detail

getList

public List<String> getList(String key)

Returns the list associated with the given key.

Parameters:

key - the key to lookup

Returns:

the list stored for the given key or an empty list, if none is present

add

public StringListMap add(String key,
                         String value)

Adds the given value to the list of the given key.

Parameters:

key - the key used to determine the target list

value - the value to add

Returns:

the map itself for fluent method calls

addToSet

public StringListMap addToSet(String key,
                              String value)

Adds the given value to the list of the given key.

Note that the list is treated like a set, therefore, if the value is already in the list, it won't be added again.

Parameters:

key - the key used to determine the target list

value - the value to add

Returns:

the map itself for fluent method calls

remove

public StringListMap remove(String key,
                            String value)

Removes the given value from the given list.

Parameters:

key - the key used to determine the list to remove the value from

value - the value to remove

Returns:

the map itself for fluent method calls

contains

public boolean contains(String key,
                        String value)

Determines if the list stored for key contains the given value.

Parameters:

key - the key used to determine the list to check

value - the value to search for

Returns:

true if the value is in the expected list, false if it isn't or if there is no list at all

clear

public StringListMap clear(String key)

Clears the list for the given key.

Parameters:

key - the key used to determine which list to clear

Returns:

the map itself for fluent method calls

valueNeedsCopy

protected boolean valueNeedsCopy()

Description copied from class: SafeMap

Determines if values in this map must be copied if the map is copied.

Specified by:

valueNeedsCopy in class SafeMap<String,List<String>>

Returns:

true if a copy is required, false otherwise

copyValue

protected List<String> copyValue(List<String> value)

Description copied from class: SafeMap

Creates a copy of the given value.

Specified by:

copyValue in class SafeMap<String,List<String>>

Parameters:

value - the value to copy

Returns:

the copy of the given value