Interface SelectionOrder

All Superinterfaces:

SelectionBase

public interface SelectionOrder
extends SelectionBase

A selection based on the filtering of victims.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object)	Whether this punishment selection is equal to another, i.e. if the other selection would match the same punishments in all circumstances.
default space.arim.omnibus.util.concurrent.ReactionStage<List<Punishment>>	getAllSpecificPunishments()	Gets all punishments matching this selection.
default space.arim.omnibus.util.concurrent.ReactionStage<Optional<Punishment>>	getFirstSpecificPunishment()	Gets the first punishment matching this selection.
SelectionPredicate<Operator>	getOperators()	Gets the operators matched
SelectionPredicate<ServerScope>	getScopes()	Gets the scopes matched
SelectionPredicate<PunishmentType>	getTypes()	Gets the punishment types matched
SelectionPredicate<Victim>	getVictims()	Gets the victims matched
SelectionPredicate<Victim.VictimType>	getVictimTypes()	Gets the victim types matched
int	limitToRetrieve()	Gets the amount of punishments to retrieve.
long	seekAfterId()	Gets the minimum ID after which punishments will be selected.
Instant	seekAfterStartTime()	Gets the minimum start time after which punishments will be selected.
boolean	selectActiveOnly()	Whether this selection will match only active, non-expired punishments.
int	skipCount()	Gets the initial amount of punishments skipped.

Methods inherited from interface SelectionBase

countNumberOfPunishments, getAllSpecificPunishments, getEscalationTracks, getFirstSpecificPunishment, seekBeforeId, seekBeforeStartTime

Method Details

getVictims

SelectionPredicate<Victim> getVictims()

Gets the victims matched

Returns:

the victims

getVictimTypes

SelectionPredicate<Victim.VictimType> getVictimTypes()

Gets the victim types matched

Returns:

the victim types

getTypes

SelectionPredicate<PunishmentType> getTypes()

Description copied from interface: SelectionBase

Gets the punishment types matched

Specified by:

getTypes in interface SelectionBase

Returns:

the punishment types

getOperators

SelectionPredicate<Operator> getOperators()

Description copied from interface: SelectionBase

Gets the operators matched

Specified by:

getOperators in interface SelectionBase

Returns:

the operators

getScopes

SelectionPredicate<ServerScope> getScopes()

Description copied from interface: SelectionBase

Gets the scopes matched

Specified by:

getScopes in interface SelectionBase

Returns:

the scopes

selectActiveOnly

boolean selectActiveOnly()

Description copied from interface: SelectionBase

Whether this selection will match only active, non-expired punishments. If false, then this selection may match any punishments, including undone or expired punishments.

Specified by:

selectActiveOnly in interface SelectionBase

Returns:

true to select only active and non-expired punishments, false to select all punishments

skipCount

int skipCount()

Description copied from interface: SelectionBase

Gets the initial amount of punishments skipped.

See SelectionBuilderBase.skipFirstRetrieved(int)

Specified by:

skipCount in interface SelectionBase

Returns:

the amount of punishments skipped

limitToRetrieve

int limitToRetrieve()

Description copied from interface: SelectionBase

Gets the amount of punishments to retrieve.

See SelectionBuilderBase.limitToRetrieve(int)

Specified by:

limitToRetrieve in interface SelectionBase

Returns:

the amount to retrieve, or 0 for unlimited

seekAfterStartTime

Instant seekAfterStartTime()

Description copied from interface: SelectionBase

Gets the minimum start time after which punishments will be selected.

See SelectionBuilderBase.seekAfter(Instant, long)

Specified by:

seekAfterStartTime in interface SelectionBase

Returns:

the minimum start time, or Instant.EPOCH for none

seekAfterId

long seekAfterId()

Description copied from interface: SelectionBase

Gets the minimum ID after which punishments will be selected.

See SelectionBuilderBase.seekAfter(Instant, long)

Specified by:

seekAfterId in interface SelectionBase

Returns:

the minimum ID, which is meaningless if SelectionBase.seekAfterStartTime() is Instant.EPOCH

getFirstSpecificPunishment

default space.arim.omnibus.util.concurrent.ReactionStage<Optional<Punishment>> getFirstSpecificPunishment()

Description copied from interface: SelectionBase

Gets the first punishment matching this selection.

If multiple punishments exist, the one chosen depends on the date enacted. The latest punishment will come first.

Specified by:

getFirstSpecificPunishment in interface SelectionBase

Returns:

a future which yields the first punishment matching this selection, or an empty optional if none matched

getAllSpecificPunishments

default space.arim.omnibus.util.concurrent.ReactionStage<List<Punishment>> getAllSpecificPunishments()

Description copied from interface: SelectionBase

Gets all punishments matching this selection.

The returned list is ordered by the date the punishment was enacted. The latest punishments come first.

Specified by:

getAllSpecificPunishments in interface SelectionBase

Returns:

a future which yields all punishments matching this selection, or an empty set if none matched

equals

boolean equals(Object object)

Description copied from interface: SelectionBase

Whether this punishment selection is equal to another, i.e. if the other selection would match the same punishments in all circumstances.

Specified by:

equals in interface SelectionBase

Overrides:

equals in class Object

Parameters:

object - the other object

Returns:

true if the objects are equal, false otherwise