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

Class FilteredEntityList

java.lang.Object

ch.tocco.nice2.persist.core.api.entity.AbstractEntityList

ch.tocco.nice2.persist.core.api.entity.AbstractEntityListWrapper

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

All Implemented Interfaces:

EntityList, Iterable<Entity>

public class FilteredEntityList
extends AbstractEntityListWrapper

A wrapper over an EntityList to possibly filter out entries.

See Also:

• EntityLists.filteredList(ch.tocco.nice2.persist.core.api.entity.EntityList, ch.tocco.nice2.persist.core.api.entity.EntityList.Filter)

Nested Class Summary

Nested classes/interfaces inherited from class ch.tocco.nice2.persist.core.api.entity.AbstractEntityList

AbstractEntityList.SimpleIterator

Nested classes/interfaces inherited from interface ch.tocco.nice2.persist.core.api.entity.EntityList

EntityList.Filter

Field Summary

Fields inherited from class ch.tocco.nice2.persist.core.api.entity.AbstractEntityListWrapper

entityList

Constructor Summary

Constructors

Constructor	Description
FilteredEntityList(EntityList entityList, EntityList.Filter filter)

Method Summary

Modifier and Type	Method	Description
Entity	get(int index, boolean eager)	Get the entity at the specified index.
@Nullable 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.
int	indexOf(PrimaryKey key)	Get the index within the list of the entity with the specified key.
int	size()	Get the number of entities this list contains.

Methods inherited from class ch.tocco.nice2.persist.core.api.entity.AbstractEntityListWrapper

getManager, getModel, getPageCount, getPageSize, setPageSize, unwrap

Methods inherited from class ch.tocco.nice2.persist.core.api.entity.AbstractEntityList

contains, expect, expectAtLeast, expectAtMost, get, get, isEmpty, iterator, toList, toList

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.tocco.nice2.persist.core.api.entity.EntityList

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

Methods inherited from interface java.lang.Iterable

forEach

Constructor Details

FilteredEntityList

public FilteredEntityList(EntityList entityList,
 EntityList.Filter filter)
                   throws PersistException

Throws:

PersistException

See Also:

• EntityLists.filteredList(ch.tocco.nice2.persist.core.api.entity.EntityList, ch.tocco.nice2.persist.core.api.entity.EntityList.Filter)

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

Overrides:

size in class AbstractEntityListWrapper

Returns:

The number of entities.

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

Overrides:

getKeys in class AbstractEntityListWrapper

Returns:

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

get

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

Description copied from interface: EntityList

Get the entity at the specified index.

Specified by:

get in interface EntityList

Overrides:

get in class AbstractEntityListWrapper

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

ArrayIndexOutOfBoundsException

get

@Nullable
public @Nullable 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

Overrides:

get in class AbstractEntityList

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

getKey

public PrimaryKey getKey(int index)

Description copied from interface: EntityList

Returns the PrimaryKey at the specified position.

Specified by:

getKey in interface EntityList

Overrides:

getKey in class AbstractEntityListWrapper

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

Overrides:

indexOf in class AbstractEntityListWrapper

Parameters:

key - The primary key.

Returns:

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