Interface DraftPunishmentBuilder

All Superinterfaces:

DraftSanctionBuilder<DraftPunishmentBuilder, DraftPunishment>

public interface DraftPunishmentBuilder
extends DraftSanctionBuilder<DraftPunishmentBuilder, DraftPunishment>

Builder of draft punishments. It is required to set the type, victim, and reason.

Method Summary

Modifier and Type	Method	Description
DraftPunishment	build()	Builds into a full draft punishment.
DraftPunishmentBuilder	duration(Duration duration)	Sets the duration of this builder to the specified one.
DraftPunishmentBuilder	escalationTrack(EscalationTrack escalationTrack)	Sets the escalation track of this builder.
DraftPunishmentBuilder	operator(Operator operator)	Sets the operator of this builder to the specified one.
DraftPunishmentBuilder	reason(String reason)	Sets the reason of this builder to the specified one.
DraftPunishmentBuilder	scope(ServerScope scope)	Sets the scope of this builder to the specified one.
DraftPunishmentBuilder	type(PunishmentType type)	Sets the punishment type of this builder to the specified one.
DraftPunishmentBuilder	victim(Victim victim)	Sets the victim of this builder to the specified one.

Method Details

type

DraftPunishmentBuilder type(PunishmentType type)

Sets the punishment type of this builder to the specified one. Required operation

Parameters:

type - the type of the punishment

Returns:

this builder

victim

DraftPunishmentBuilder victim(Victim victim)

Description copied from interface: DraftSanctionBuilder

Sets the victim of this builder to the specified one. Required operation.

If the victim is a CompositeVictim, it cannot use either CompositeVictim.WILDCARD_UUID or CompositeVictim.WILDCARD_ADDRESS

Specified by:

victim in interface DraftSanctionBuilder<DraftPunishmentBuilder, DraftPunishment>

Parameters:

victim - the victim of the punishmnt

Returns:

this builder

operator

DraftPunishmentBuilder operator(Operator operator)

Description copied from interface: DraftSanctionBuilder

Sets the operator of this builder to the specified one. If unspecified, the console operator is used (ConsoleOperator.INSTANCE)

Specified by:

operator in interface DraftSanctionBuilder<DraftPunishmentBuilder, DraftPunishment>

Parameters:

operator - the operator of the punishment, by default the console

Returns:

this builder

reason

DraftPunishmentBuilder reason(String reason)

Sets the reason of this builder to the specified one. Required operation

Parameters:

reason - the reason of the punishment

Returns:

this builder

duration

DraftPunishmentBuilder duration(Duration duration)

Sets the duration of this builder to the specified one. If unspecified, a duration of zero, indicating a permanent duration, is used

Parameters:

duration - the duration of the punishment, or zero for a permanent punishment

Returns:

this builder

Throws:

IllegalArgumentException - if duration is negative

scope

DraftPunishmentBuilder scope(ServerScope scope)

Sets the scope of this builder to the specified one. If unspecified, the global scope is used

Parameters:

scope - the scope of the punishment

Returns:

this builder

escalationTrack

DraftPunishmentBuilder escalationTrack(EscalationTrack escalationTrack)

Sets the escalation track of this builder. If unspecified, no escalation track is used.

Parameters:

escalationTrack - the escalation track, or null for none

Returns:

this builder

build

DraftPunishment build()

Builds into a full draft punishment. All the required information must be set on this builder.

May be used repeatedly without side effects.

Specified by:

build in interface DraftSanctionBuilder<DraftPunishmentBuilder, DraftPunishment>

Returns:

a draft punishment from this builder's details

Throws:

IllegalStateException - if any of the required details on this builder are not set

IllegalArgumentException - if the punishment type of this builder is PunishmentType.KICK and the duration is not permanent