sirius.db.mixing.types

Class BaseEntityRefList<E extends BaseEntity<String>,L extends BaseEntityRefList<E,L>>

java.lang.Object

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

sirius.db.mixing.types.BaseEntityRefList<E,L>

Type Parameters:

E - the type of entities being stored in this list

L - the effective subclass used as fluent return type

All Implemented Interfaces:

Iterable<String>

Direct Known Subclasses:

ElasticRefList, MongoRefList

public abstract class BaseEntityRefList<E extends BaseEntity<String>,L extends BaseEntityRefList<E,L>>
extends SafeList<String>

Represents a list of IDs (strings) which represents subclasses of BaseEntity.

The main benefit over simply using a plain StringList is the referential integrity provided via the given delete handler.

Field Summary

Fields

Modifier and Type	Field and Description
protected BaseEntityRef.OnDelete	deleteHandler
protected Class<E>	type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseEntityRefList(Class<E> type, BaseEntityRef.OnDelete deleteHandler)

Method Summary

Modifier and Type	Method and Description
L	add(E entity) Adds the given entity to the list.
boolean	contains(E entity) Determines if the given entity is in the list.
protected String	copyValue(String value) Creates a copy of the given value.
Stream<Optional<E>>	fetchAll(ContextInfo... context) Retruns all entity in the list by resolving them against the database.
Stream<E>	fetchAllAvailable(ContextInfo... context) Retruns all entity in the list by resolving them against the database.
BaseEntityRef.OnDelete	getDeleteHandler() Returns the delete handler to use.
Class<E>	getType() Returns the underlying entity type.
L	remove(E entity) Removes the given entity from the list.
protected abstract Optional<E>	resolve(String id, ContextInfo... context) Resolves a given ID into an entity instance.
protected boolean	valueNeedsCopy() Determines if values in this list must be copied if the list is copied.

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

add, addAll, clear, contains, copyList, data, equals, forEach, hashCode, isEmpty, isFilled, iterator, modify, original, setData, size, spliterator, toString

Methods inherited from class java.lang.Object

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

Field Detail

deleteHandler

protected BaseEntityRef.OnDelete deleteHandler

type

protected Class<E extends BaseEntity<String>> type

Constructor Detail

BaseEntityRefList

protected BaseEntityRefList(Class<E> type,
                            BaseEntityRef.OnDelete deleteHandler)

Method Detail

resolve

protected abstract Optional<E> resolve(String id,
                                       ContextInfo... context)

Resolves a given ID into an entity instance.

Parameters:

id - the id to resolve

context - the context used for resolving (routing etc.)

Returns:

the resolved entity wrapped as optional or an empty optional of the entity doesn't exist

add

public L add(E entity)

Adds the given entity to the list.

If the entity is null or new, nothing will happen.

Parameters:

entity - the entity to add

Returns:

the list itself for fluent method calls

remove

public L remove(E entity)

Removes the given entity from the list.

If the entity is null or new, nothing will happen.

Parameters:

entity - the entity to remove

Returns:

the list itself for fluent method calls

contains

public boolean contains(E entity)

Determines if the given entity is in the list.

Parameters:

entity - the entity to check for.

Returns:

true if the entity is in the list, false if the entity was new, null or not in the list

fetchAll

public Stream<Optional<E>> fetchAll(ContextInfo... context)

Retruns all entity in the list by resolving them against the database.

This will perform N uncached lookups against the database - use with caution.

Parameters:

context - the lookup context

Returns:

a stream of all entities in the list, wrapped as optional. May contain empty optionals for stale IDs

fetchAllAvailable

public Stream<E> fetchAllAvailable(ContextInfo... context)

Retruns all entity in the list by resolving them against the database.

This will perform N uncached lookups against the database - use with caution.

Parameters:

context - the lookup context

Returns:

a stream of all entities in the list which also exist in the database

valueNeedsCopy

protected boolean valueNeedsCopy()

Description copied from class: SafeList

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

Specified by:

valueNeedsCopy in class SafeList<String>

Returns:

true if a copy is required, false otherwise

copyValue

protected String copyValue(String value)

Description copied from class: SafeList

Creates a copy of the given value.

Specified by:

copyValue in class SafeList<String>

Parameters:

value - the value to copy

Returns:

the copy of the given value

getDeleteHandler

public BaseEntityRef.OnDelete getDeleteHandler()

Returns the delete handler to use.

Returns:

the delete handler to enforce for the list of IDs

getType

public Class<E> getType()

Returns the underlying entity type.

Returns:

the type of entities being stored / represented by this list