Class SingletonEntityList

java.lang.Object

ch.tocco.nice2.persist.core.api.util.SingletonEntityList

All Implemented Interfaces:

EntityList, Iterable<Entity>

public class SingletonEntityList
extends Object
implements EntityList

Nested Class Summary

Nested classes/interfaces inherited from interface EntityList

EntityList.Filter

Constructor Summary

Constructors

Constructor	Description
SingletonEntityList(Entity entity)
SingletonEntityList(Entity entity, EntityManager manager)

Method Summary

Modifier and Type	Method	Description
boolean	contains(PrimaryKey key)	Determine, whether the list contains an entity with the specified key.
EntityList	expect(int amount)	Throws if the list does not contain exactly that amount.
EntityList	expectAtLeast(int min)	Throws if the list contains fewer than min items.
EntityList	expectAtMost(int max)	Throws if the list contains more than max items.
Entity	get(int index)	Get the entity at the specified index with eager loading.
Entity	get(int index, boolean eager)	Get the entity at the specified index.
Entity	get(PrimaryKey key)	Get the entity with the specified key in that list with eager loading.
Entity	get(PrimaryKey key, boolean eager)	Get the entity with the specified key in that list.
PrimaryKey	getKey(int index)	Returns the PrimaryKey at the specified position.
PrimaryKey[]	getKeys()	Read in subclasses if this array can contain null values or not.
EntityManager	getManager()	Get the entity manager.
EntityModel	getModel()	Get the model of the entity type contained in this list.
int	getPageCount()	Get the number of pages in this list.
int	getPageSize()	Get the current page size.
int	indexOf(PrimaryKey key)	Get the index within the list of the entity with the specified key.
boolean	isEmpty()	Same as size() == 0
Iterator<Entity>	iterator()
void	setPageSize(int pageSize)	Set the page size.
int	size()	Get the number of entities this list contains.
List<Entity>	toList()	Returns the Entities of this list in a List using eager loading.
List<Entity>	toList(Predicate<Entity> filter)	Returns the Entities of this list in a List using eager loading.
EntityList	unwrap()	Unwrap to the underlying entity list.

Methods inherited from class Object

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

Methods inherited from interface EntityList

doWithSingleResult, doWithSingleResultOr, expectAtMostOrThrow, expectOr, expectOrThrow, getFirstEntity, getOnlyResult, getOptionalOnlyResult, getOptionalOnlyResult, requireFirstEntity, spliterator, stream

Methods inherited from interface Iterable

forEach

Constructor Details

SingletonEntityList

public SingletonEntityList(Entity entity,
 EntityManager manager)

SingletonEntityList

public SingletonEntityList(Entity entity)

Method Details

size

public int size()

Description copied from interface: EntityList

Get the number of entities this list contains.

Specified by:

size in interface EntityList

Returns:

The number of entities.

isEmpty

public boolean isEmpty()

Description copied from interface: EntityList

Same as size() == 0

Specified by:

isEmpty in interface EntityList

Returns:

If the list is empty.

getKeys

public PrimaryKey[] getKeys()

Description copied from interface: EntityList

Read in subclasses if this array can contain null values or not.

Specified by:

getKeys in interface EntityList

Returns:

A defensive copy of the array. The size matches the EntityList.size() method.

get

public Entity get(int index)
           throws PersistException

Description copied from interface: EntityList

Get the entity at the specified index with eager loading.

This method will load a full page if the entity is currently hollow.

Specified by:

get in interface EntityList

Parameters:

index - The index.

Returns:

The entity at the specified index potentially in unusable state, or null.

Throws:

PersistException

get

public Entity get(PrimaryKey key)
           throws PersistException

Description copied from interface: EntityList

Get the entity with the specified key in that list with eager loading.

Specified by:

get in interface EntityList

Returns:

The entity potentially in unusable state, or null.

Throws:

PersistException

See Also:

• EntityList.get(PrimaryKey, boolean)

get

public Entity get(int index,
 boolean eager)
           throws PersistException

Description copied from interface: EntityList

Get the entity at the specified index.

Specified by:

get in interface EntityList

Parameters:

index - The index.

eager - true, if a page should be eagerly loaded, if the entity's state is hollow, false otherwise.

Returns:

The entity at the specified index potentially in unusable state, or null.

Throws:

PersistException

get

public Entity get(PrimaryKey key,
 boolean eager)
           throws PersistException

Description copied from interface: EntityList

Get the entity with the specified key in that list.

Specified by:

get in interface EntityList

Parameters:

key - The key of the entity.

eager - true, if a page should be eagerly loaded, if the entity's state is hollow, false otherwise.

Returns:

The entity with the specified key potentially in unusable state, or null.

Throws:

PersistException

toList

public List<Entity> toList()
                    throws PersistException

Description copied from interface: EntityList

Returns the Entities of this list in a List using eager loading.

Specified by:

toList in interface EntityList

Throws:

PersistException

toList

public List<Entity> toList(Predicate<Entity> filter)
                    throws PersistException

Description copied from interface: EntityList

Returns the Entities of this list in a List using eager loading.

Specified by:

toList in interface EntityList

Throws:

PersistException

getKey

public PrimaryKey getKey(int index)

Description copied from interface: EntityList

Returns the PrimaryKey at the specified position.

Specified by:

getKey in interface EntityList

indexOf

public int indexOf(PrimaryKey key)

Description copied from interface: EntityList

Get the index within the list of the entity with the specified key.

Specified by:

indexOf in interface EntityList

Parameters:

key - The primary key.

Returns:

The index or -1, if there's no such entity in the list.

contains

public boolean contains(PrimaryKey key)

Description copied from interface: EntityList

Determine, whether the list contains an entity with the specified key.

Specified by:

contains in interface EntityList

Parameters:

key - The primary key.

Returns:

true, if there's an entity with the specified key, false otherwise.

expect

public EntityList expect(int amount)
                  throws PermanentPersistException

Description copied from interface: EntityList

Throws if the list does not contain exactly that amount.

Example: EntityList entityList = myQuery.execute(1).expect(1);

Specified by:

expect in interface EntityList

Parameters:

amount - The expected amount.

Returns:

The list itself.

Throws:

PermanentPersistException

See Also:

• EntityList.expectAtLeast(int)
• EntityList.expectAtMost(int)

expectAtLeast

public EntityList expectAtLeast(int min)
                         throws PermanentPersistException

Description copied from interface: EntityList

Throws if the list contains fewer than min items.

Example: EntityList entityList = myQuery.execute().expectAtLeast(3);

Specified by:

expectAtLeast in interface EntityList

Parameters:

min - The expected minimal amount, including.

Returns:

The list itself.

Throws:

PermanentPersistException

See Also:

• EntityList.expect(int)
• EntityList.expectAtMost(int)

expectAtMost

public EntityList expectAtMost(int max)
                        throws PermanentPersistException

Description copied from interface: EntityList

Throws if the list contains more than max items.

Example: EntityList entityList = myQuery.execute(3).expectAtMost(3);

Specified by:

expectAtMost in interface EntityList

Parameters:

max - The expected maximal amount, including.

Returns:

The list itself.

Throws:

PermanentPersistException

See Also:

• EntityList.expect(int)
• EntityList.expectAtLeast(int)

getModel

public EntityModel getModel()

Description copied from interface: EntityList

Get the model of the entity type contained in this list.

Specified by:

getModel in interface EntityList

Returns:

The model of the entity type contained in this list.

getManager

public EntityManager getManager()

Description copied from interface: EntityList

Get the entity manager.

Specified by:

getManager in interface EntityList

Returns:

The entity manager.

unwrap

public EntityList unwrap()

Description copied from interface: EntityList

Unwrap to the underlying entity list.

Wrappers of entity lists should delegate this to the list they're wrapping, implementations return this. It may be that they cannot, and then return themselves (MultiEntityList).

Specified by:

unwrap in interface EntityList

Returns:

The underlying entity list implementation.

setPageSize

public void setPageSize(int pageSize)

Description copied from interface: EntityList

Set the page size. The page size determines how many objects will be loaded, once a hollow entity has been accessed.

Specified by:

setPageSize in interface EntityList

Parameters:

pageSize - The new page size.

getPageSize

public int getPageSize()

Description copied from interface: EntityList

Get the current page size.

Specified by:

getPageSize in interface EntityList

Returns:

The current page size.

getPageCount

public int getPageCount()

Description copied from interface: EntityList

Get the number of pages in this list.

Specified by:

getPageCount in interface EntityList

Returns:

The number of pages in this list (size/pageSize + (size%pageSize>0 ? 1 : 0)).

iterator

public Iterator<Entity> iterator()

Specified by:

iterator in interface Iterable<Entity>