Interface SelectionOrderBuilder

All Superinterfaces:

SelectionBuilderBase<SelectionOrderBuilder, SelectionOrder>

public interface SelectionOrderBuilder
extends SelectionBuilderBase<SelectionOrderBuilder, SelectionOrder>

Builder for SelectionOrder. No required details

Method Summary

Modifier and Type	Method	Description
SelectionOrder	build()	Builds a selection from the details of this builder.
SelectionOrderBuilder	limitToRetrieve(int limitToRetrieve)	Sets the amount of punishments to retrieve.
default SelectionOrderBuilder	operator(Operator operator)	Sets the operator matched.
SelectionOrderBuilder	operators(SelectionPredicate<Operator> operators)	Sets the operators matched.
default SelectionOrderBuilder	scope(ServerScope scope)	Sets the scope matched.
SelectionOrderBuilder	scopes(SelectionPredicate<ServerScope> scopes)	Sets the scopes matched.
SelectionOrderBuilder	seekAfter(Instant minimumStartTime, long minimumId)	Sets the time after which punishments will be retrieved.
default SelectionOrderBuilder	selectActiveOnly()	Sets that only active punishments should be matched.
SelectionOrderBuilder	selectActiveOnly(boolean selectActiveOnly)	Sets whether only active punishments should be matched.
default SelectionOrderBuilder	selectAll()	Sets that all punishments, not just those active, should be matched.
SelectionOrderBuilder	skipFirstRetrieved(int skipCount)	Sets the amount of punishments to skip when retrieving.
default SelectionOrderBuilder	type(PunishmentType type)	Sets the punishment type matched.
SelectionOrderBuilder	types(SelectionPredicate<PunishmentType> types)	Sets the punishment types matched.
default SelectionOrderBuilder	victim(Victim victim)	Sets the victim matched.
SelectionOrderBuilder	victims(SelectionPredicate<Victim> victims)	Sets the victims matched.
default SelectionOrderBuilder	victimType(Victim.VictimType victimType)	Sets the victim type matched.
SelectionOrderBuilder	victimTypes(SelectionPredicate<Victim.VictimType> victimTypes)	Sets the victim types matched.

Methods inherited from interface SelectionBuilderBase

escalationTrack, escalationTracks, seekBefore

Method Details

victim

default SelectionOrderBuilder victim(Victim victim)

Sets the victim matched. All are matched by default.

Please see victims(SelectionPredicate) for how this interacts with composite victims.

Parameters:

victim - the victim

Returns:

this builder

victims

SelectionOrderBuilder victims(SelectionPredicate<Victim> victims)

Sets the victims matched. All are matched by default.

Composite victims have somewhat special handling which reflects their purpose as an "either-or" kind of victim. That is, specifying a composite victim in set of the accepted victims will select all punishments which partially but not entirely match that composite victim. Formally, if the selected victim is a composite victim, and its UUID matches the specified composite victim OR its address matches the specified composite, then the selected victim is matched.

For example, specifying a composite victim of new UUID(1, 1) and address 127.0.0.1 will match all composite victims whose UUID is new UUID(1, 1) OR whose address is 127.0.0.1. However, specifying a composite victim will not match other kinds of victims.

Parameters:

victims - the victim predicate

Returns:

this builder

victimType

default SelectionOrderBuilder victimType(Victim.VictimType victimType)

Sets the victim type matched. All are matched by default.

Parameters:

victimType - the victim type to match

Returns:

this builder

victimTypes

SelectionOrderBuilder victimTypes(SelectionPredicate<Victim.VictimType> victimTypes)

Sets the victim types matched. All are matched by default.

Parameters:

victimTypes - the victim types

Returns:

this builder

type

default SelectionOrderBuilder type(PunishmentType type)

Description copied from interface: SelectionBuilderBase

Sets the punishment type matched. All are matched by default.

Specified by:

type in interface SelectionBuilderBase<SelectionOrderBuilder, SelectionOrder>

Parameters:

type - the punishment type

Returns:

this builder

types

SelectionOrderBuilder types(SelectionPredicate<PunishmentType> types)

Description copied from interface: SelectionBuilderBase

Sets the punishment types matched. All are matched by default.

Specified by:

types in interface SelectionBuilderBase<SelectionOrderBuilder, SelectionOrder>

Parameters:

types - the punishment type predicate

Returns:

this builder

operator

default SelectionOrderBuilder operator(Operator operator)

Description copied from interface: SelectionBuilderBase

Sets the operator matched. All are matched by default.

Specified by:

operator in interface SelectionBuilderBase<SelectionOrderBuilder, SelectionOrder>

Parameters:

operator - the operator

Returns:

this builder

operators

SelectionOrderBuilder operators(SelectionPredicate<Operator> operators)

Description copied from interface: SelectionBuilderBase

Sets the operators matched. All are matched by default.

Specified by:

operators in interface SelectionBuilderBase<SelectionOrderBuilder, SelectionOrder>

Parameters:

operators - the operator predicate

Returns:

this builder

scope

default SelectionOrderBuilder scope(ServerScope scope)

Description copied from interface: SelectionBuilderBase

Sets the scope matched. All are matched by default.

Specified by:

scope in interface SelectionBuilderBase<SelectionOrderBuilder, SelectionOrder>

Parameters:

scope - the scope

Returns:

this builder

scopes

SelectionOrderBuilder scopes(SelectionPredicate<ServerScope> scopes)

Description copied from interface: SelectionBuilderBase

Sets the scopes matched. All are matched by default.

Specified by:

scopes in interface SelectionBuilderBase<SelectionOrderBuilder, SelectionOrder>

Parameters:

scopes - the scope predicate

Returns:

this builder

selectActiveOnly

SelectionOrderBuilder selectActiveOnly(boolean selectActiveOnly)

Description copied from interface: SelectionBuilderBase

Sets whether only active punishments should be matched. True by default, meaning only active punishments are selected.

Active punishments are those not expired and not undone.

Specified by:

selectActiveOnly in interface SelectionBuilderBase<SelectionOrderBuilder, SelectionOrder>

Parameters:

selectActiveOnly - whether to select active punishments only

Returns:

this builder

selectActiveOnly

default SelectionOrderBuilder selectActiveOnly()

Description copied from interface: SelectionBuilderBase

Sets that only active punishments should be matched. Enabled by default, meaning only active punishments are selected.

Active punishments are those not expired and not undone.

Specified by:

selectActiveOnly in interface SelectionBuilderBase<SelectionOrderBuilder, SelectionOrder>

Returns:

this builder

selectAll

default SelectionOrderBuilder selectAll()

Description copied from interface: SelectionBuilderBase

Sets that all punishments, not just those active, should be matched. When this method is used, historical punishments and expired punishments are selected.

Active punishments are those not expired and not undone.

Specified by:

selectAll in interface SelectionBuilderBase<SelectionOrderBuilder, SelectionOrder>

Returns:

this builder

skipFirstRetrieved

SelectionOrderBuilder skipFirstRetrieved(int skipCount)

Description copied from interface: SelectionBuilderBase

Sets the amount of punishments to skip when retrieving. No punishments are skipped by default.

This method may be used to implement offset pagination of selected punishments, together with SelectionBuilderBase.limitToRetrieve(int).

Behavior is unspecified if this is used simultaneously with SelectionBuilderBase.seekAfter(Instant, long). Callers should consider the methods exclusive to avoid unspecified behavior.

Specified by:

skipFirstRetrieved in interface SelectionBuilderBase<SelectionOrderBuilder, SelectionOrder>

Parameters:

skipCount - the amount of punishments to skip

Returns:

this builder

limitToRetrieve

SelectionOrderBuilder limitToRetrieve(int limitToRetrieve)

Description copied from interface: SelectionBuilderBase

Sets the amount of punishments to retrieve. Unlimited by default.

If this is used with SelectionBuilderBase.skipFirstRetrieved(int), the amount of punishments retrieved is still equal to limitToRetrieve. In other words, this method is the same as SQL's LIMIT clause.

Specified by:

limitToRetrieve in interface SelectionBuilderBase<SelectionOrderBuilder, SelectionOrder>

Parameters:

limitToRetrieve - the amount of punishments to retrieve, 0 for unlimited

Returns:

this builder

seekAfter

SelectionOrderBuilder seekAfter(Instant minimumStartTime,
 long minimumId)

Description copied from interface: SelectionBuilderBase

Sets the time after which punishments will be retrieved. Only punishments whose start time (Punishment.getStartDate()) is after or equal to the given value will be selected.

If a punishment has a start time equal to minimumStartTime, its ID will be checked against minimumId. The punishment will then be selected if its ID is equal to or greater than minimumId.

To reset this option to the default value, use a minimum start time of Instant.EPOCH, in which case the minimum ID is ignored.
This method may be used to implement keyset pagination of selected punishments, together with SelectionBuilderBase.limitToRetrieve(int).

Behavior is unspecified if this is used simultaneously with SelectionBuilderBase.skipFirstRetrieved(int). Callers should consider the methods exclusive to avoid unspecified behavior.

Specified by:

seekAfter in interface SelectionBuilderBase<SelectionOrderBuilder, SelectionOrder>

Parameters:

minimumStartTime - the minimum start time, or Instant.EPOCH to reset this option

minimumId - the minimum ID

Returns:

this builder

build

SelectionOrder build()

Description copied from interface: SelectionBuilderBase

Builds a selection from the details of this builder. May be used repeatedly without side effects.

Specified by:

build in interface SelectionBuilderBase<SelectionOrderBuilder, SelectionOrder>

Returns:

a selection from this builder's details