sirius.db.mixing.types

Class SafeList<T>

java.lang.Object

sirius.db.mixing.types.SafeList<T>

Type Parameters:

T - the type of objects stored in this list

All Implemented Interfaces:

Iterable<T>

Direct Known Subclasses:

BaseEntityRefList, MultiPointLocation, NestedList, StringList

public abstract class SafeList<T>
extends Object
implements Iterable<T>

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

Constructor Summary

Constructors

Constructor and Description
SafeList()

Method Summary

Modifier and Type	Method and Description
SafeList<T>	add(T item) Adds a new item to the list.
SafeList<T>	addAll(Collection<T> items) Adds all items to the list.
SafeList<T>	clear() Clears the list.
boolean	contains(T item) Determines if the list contains the given item.
List<T>	copyList() Creates a copy of the underlying list.
protected abstract T	copyValue(T value) Creates a copy of the given value.
List<T>	data() Provides readonly access to the underlying list.
boolean	equals(Object obj)
void	forEach(Consumer<? super T> action)
int	hashCode()
boolean	isEmpty() Determines if the list is empty.
boolean	isFilled() Determines if the list is not empty.
Iterator<T>	iterator()
List<T>	modify() Provides read and write access to the underlying list.
List<T>	original() Provides access to the list which was origrinally used to supply contents.
void	setData(List<T> newData) Sets the underyling list to use.
int	size() Determines the size of the list.
Spliterator<T>	spliterator()
String	toString()
protected abstract boolean	valueNeedsCopy() Determines if values in this list must be copied if the list is copied.

Methods inherited from class java.lang.Object

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

Constructor Detail

SafeList

public SafeList()

Method Detail

data

public List<T> data()

Provides readonly access to the underlying list.

Returns:

a readonly version of the underlying list

modify

public List<T> modify()

Provides read and write access to the underlying list.

Returns:

the underlying list

valueNeedsCopy

protected abstract boolean valueNeedsCopy()

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

Returns:

true if a copy is required, false otherwise

copyValue

protected abstract T copyValue(T value)

Creates a copy of the given value.

Parameters:

value - the value to copy

Returns:

the copy of the given value

original

public List<T> original()

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

In contrast to modify() this will not create a new list 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 list which was loaded from the database or an empty list if none is present

setData

public void setData(List<T> newData)

Sets the underyling list 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 list to use

add

public SafeList<T> add(T item)

Adds a new item to the list.

Parameters:

item - the item to add

Returns:

the list itself for fluent method calls

addAll

public SafeList<T> addAll(Collection<T> items)

Adds all items to the list.

Parameters:

items - the items to add

Returns:

the list itself for fluent method calls

clear

public SafeList<T> clear()

Clears the list.

Returns:

the list itself for fluent method calls

size

public int size()

Determines the size of the list.

Returns:

the number of items in the list

isEmpty

public boolean isEmpty()

Determines if the list is empty.

Returns:

true if the list is empty, false otherwise

isFilled

public boolean isFilled()

Determines if the list is not empty.

Returns:

true if the list is not empty, false otherwise

contains

public boolean contains(T item)

Determines if the list contains the given item.

Parameters:

item - the item to check for

Returns:

true if the list contains the item, false otherwise

iterator

@Nonnull
public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

forEach

public void forEach(Consumer<? super T> action)

Specified by:

forEach in interface Iterable<T>

spliterator

public Spliterator<T> spliterator()

Specified by:

spliterator in interface Iterable<T>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

copyList

public List<T> copyList()

Creates a copy of the underlying list.

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

Returns:

a copy of the internally stored list