sirius.db.mixing.types

Class SafeMap<K,V>

java.lang.Object

sirius.db.mixing.types.SafeMap<K,V>

Type Parameters:

K - the type of keys of this map

V - the type of values of this map

All Implemented Interfaces:

Iterable<Map.Entry<K,V>>

Direct Known Subclasses:

StringIntMap, StringListMap, StringLocalDateTimeMap, StringMap, StringNestedMap

public abstract class SafeMap<K,V>
extends Object
implements Iterable<Map.Entry<K,V>>

Describes a map of objects which can be stored in an entity as property value.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<K,V>	data

Constructor Summary

Constructors

Constructor and Description
SafeMap()

Method Summary

Modifier and Type	Method and Description
SafeMap<K,V>	clear() Clears the entire map.
boolean	containsKey(K key) Determines if the map contains the given key.
Map<K,V>	copyMap() Creates a copy of the underlying map.
protected abstract V	copyValue(V value) Creates a copy of the given value.
Map<K,V>	data() Provides readonly access to the underlying map.
boolean	equals(Object obj)
void	forEach(Consumer<? super Map.Entry<K,V>> action)
Optional<V>	get(K key) Returns the value stored for the given key.
int	hashCode()
boolean	isEmpty() Determines if the map is empty.
boolean	isFilled() Determines if the map is not empty.
Iterator<Map.Entry<K,V>>	iterator()
Map<K,V>	modify() Provides read and write access to the underlying map.
Map<K,V>	original() Provides access to the map which was origrinally used to supply contents.
SafeMap<K,V>	put(K key, V value) Puts the given key and value into the map.
void	setData(Map<K,V> newData) Sets the underyling map to use.
int	size() Returns the number of entries in the map.
Spliterator<Map.Entry<K,V>>	spliterator()
protected abstract boolean	valueNeedsCopy() Determines if values in this map must be copied if the map is copied.

Methods inherited from class java.lang.Object

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

Field Detail

data

protected Map<K,V> data

Constructor Detail

SafeMap

public SafeMap()

Method Detail

data

public Map<K,V> data()

Provides readonly access to the underlying map.

Returns:

a readonly version of the underlying map

modify

public Map<K,V> modify()

Provides read and write access to the underlying map.

Returns:

the underlying map

put

public SafeMap<K,V> put(K key,
                        V value)

Puts the given key and value into the map.

Parameters:

key - the key used to store the value

value - the value to store

Returns:

the map itself for fluent method calls

get

public Optional<V> get(K key)

Returns the value stored for the given key.

Parameters:

key - the key used to lookup the value

Returns:

the value wrapped as optional or an empty optional if either null or nothing was stored for the given key.

clear

public SafeMap<K,V> clear()

Clears the entire map.

Returns:

the map itself for fluent method calls

copyMap

public Map<K,V> copyMap()

Creates a copy of the underlying map.

This is used by the framework to permit change tracking. If we wouldn't create a copy of the map, the "original" backup and the map in the entity would be the same and therefore no modifications would be recognized.

Returns:

a copy of the internally stored map

valueNeedsCopy

protected abstract boolean valueNeedsCopy()

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

Returns:

true if a copy is required, false otherwise

copyValue

protected abstract V copyValue(V value)

Creates a copy of the given value.

Parameters:

value - the value to copy

Returns:

the copy of the given value

original

public Map<K,V> original()

Provides access to the map which was origrinally used to supply contents.

In contrast to modify() this will not create a new map if none is present yet. Therefore the result might be readonly. The is mainly used by the storage engine to re-use internal data structures as much as possible.

Returns:

the original map which was loaded from the database or an empty map if none is present

setData

public void setData(Map<K,V> newData)

Sets the underyling map to use.

As original() this should only be used by the storage engine to insert a database specific implementation which can later be re-used.

Parameters:

newData - the new map to use

size

public int size()

Returns the number of entries in the map.

Returns:

the number of entries in the map

isEmpty

public boolean isEmpty()

Determines if the map is empty.

Returns:

true if the map is empty, false otherwise

isFilled

public boolean isFilled()

Determines if the map is not empty.

Returns:

true if the map is not empty, false otherwise

containsKey

public boolean containsKey(K key)

Determines if the map contains the given key.

Parameters:

key - the key to check for

Returns:

true if the map contains the key, false otherwise

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

iterator

@Nonnull
public Iterator<Map.Entry<K,V>> iterator()

Specified by:

iterator in interface Iterable<Map.Entry<K,V>>

forEach

public void forEach(Consumer<? super Map.Entry<K,V>> action)

Specified by:

forEach in interface Iterable<Map.Entry<K,V>>

spliterator

public Spliterator<Map.Entry<K,V>> spliterator()

Specified by:

spliterator in interface Iterable<Map.Entry<K,V>>