io.spine.server.entity.storage

Class QueryParameters

java.lang.Object

io.spine.server.entity.storage.QueryParameters

All Implemented Interfaces:

java.lang.Iterable<CompositeQueryParameter>

@SPI
public final class QueryParameters
extends java.lang.Object
implements java.lang.Iterable<CompositeQueryParameter>

The parameters of an EntityQuery.

QueryParameters are passed into the Storage implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryParameters.Builder The builder for the QueryParameters.

Method Summary

Modifier and Type	Method and Description
static QueryParameters	activeEntityQueryParams(RecordStorage<?> storage) Creates a new QueryParameters instance which includes filters for column lifecycle flags to equal false.
boolean	equals(java.lang.Object o)
int	hashCode()
boolean	isLifecycleAttributesSet() Verifies whether this parameters include filters by the Entity lifecycle flags or not.
java.util.Iterator<CompositeQueryParameter>	iterator() Returns an iterator over the column filters.
static QueryParameters.Builder	newBuilder()
static QueryParameters.Builder	newBuilder(QueryParameters parameters)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

newBuilder

public static QueryParameters.Builder newBuilder()

newBuilder

public static QueryParameters.Builder newBuilder(QueryParameters parameters)

activeEntityQueryParams

public static QueryParameters activeEntityQueryParams(RecordStorage<?> storage)

Creates a new QueryParameters instance which includes filters for column lifecycle flags to equal false. Such an entity is considered to be active.

Parameters:

storage - the record storage persisting target entities

Returns:

new QueryParameters with lifecycle flags filters

iterator

public java.util.Iterator<CompositeQueryParameter> iterator()

Returns an iterator over the column filters.

The resulting Iterator throws UnsupportedOperationException on call to Iterator.remove().

Specified by:

iterator in interface java.lang.Iterable<CompositeQueryParameter>

Returns:

an Iterator.

isLifecycleAttributesSet

public boolean isLifecycleAttributesSet()

Verifies whether this parameters include filters by the Entity lifecycle flags or not.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object