Package org.incendo.cloud.processors.cooldown

Class ImmutableCooldownConfiguration.Builder<C>

java.lang.Object

org.incendo.cloud.processors.cooldown.ImmutableCooldownConfiguration.Builder<C>

All Implemented Interfaces:

ImmutableCooldownConfiguration.BuildFinal<C>, ImmutableCooldownConfiguration.RepositoryBuildStage<C>

Enclosing class:

ImmutableCooldownConfiguration<C>

public static final class ImmutableCooldownConfiguration.Builder<C>
extends Object
implements ImmutableCooldownConfiguration.RepositoryBuildStage<C>, ImmutableCooldownConfiguration.BuildFinal<C>

Builds instances of type ImmutableCooldownConfiguration. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method	Description
final ImmutableCooldownConfiguration.Builder<C>	addActiveCooldownListener(CooldownActiveListener<C> element)	Adds one element to activeCooldownListeners list.
final ImmutableCooldownConfiguration.Builder<C>	addActiveCooldownListeners(CooldownActiveListener<C>... elements)	Adds elements to activeCooldownListeners list.
final ImmutableCooldownConfiguration.Builder<C>	addAllActiveCooldownListeners(Iterable<? extends CooldownActiveListener<C>> elements)	Adds elements to activeCooldownListeners list.
final ImmutableCooldownConfiguration.Builder<C>	addAllCreationListeners(Iterable<? extends CooldownCreationListener<C>> elements)	Adds elements to creationListeners list.
final ImmutableCooldownConfiguration.Builder<C>	addCreationListener(CooldownCreationListener<C> element)	Adds one element to creationListeners list.
final ImmutableCooldownConfiguration.Builder<C>	addCreationListeners(CooldownCreationListener<C>... elements)	Adds elements to creationListeners list.
ImmutableCooldownConfiguration<C>	build()	Builds a new ImmutableCooldownConfiguration.
final ImmutableCooldownConfiguration.Builder<C>	bypassCooldown(@NonNull Predicate<CommandContext<C>> bypassCooldown)	Initializes the value for the bypassCooldown attribute.
final ImmutableCooldownConfiguration.Builder<C>	clock(@NonNull Clock clock)	Initializes the value for the clock attribute.
final ImmutableCooldownConfiguration.Builder<C>	fallbackGroup(@NonNull Function<Command<C>,CooldownGroup> fallbackGroup)	Initializes the value for the fallbackGroup attribute.
final ImmutableCooldownConfiguration.Builder<C>	profileFactory(@NonNull CooldownProfileFactory profileFactory)	Initializes the value for the profileFactory attribute.
final ImmutableCooldownConfiguration.Builder<C>	repository(@NonNull CooldownRepository<C> repository)	Initializes the value for the repository attribute.

Methods inherited from class java.lang.Object

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

Method Details

repository

public final ImmutableCooldownConfiguration.Builder<C> repository(@NonNull CooldownRepository<C> repository)

Initializes the value for the repository attribute.

Specified by:

repository in interface ImmutableCooldownConfiguration.RepositoryBuildStage<C>

Parameters:

repository - The value for repository

Returns:

this builder for use in a chained invocation

addActiveCooldownListener

public final ImmutableCooldownConfiguration.Builder<C> addActiveCooldownListener(CooldownActiveListener<C> element)

Adds one element to activeCooldownListeners list.

Specified by:

addActiveCooldownListener in interface ImmutableCooldownConfiguration.BuildFinal<C>

Parameters:

element - A activeCooldownListeners element

Returns:

this builder for use in a chained invocation

addActiveCooldownListeners

@SafeVarargs
public final ImmutableCooldownConfiguration.Builder<C> addActiveCooldownListeners(CooldownActiveListener<C>... elements)

Adds elements to activeCooldownListeners list.

Specified by:

addActiveCooldownListeners in interface ImmutableCooldownConfiguration.BuildFinal<C>

Parameters:

elements - An array of activeCooldownListeners elements

Returns:

this builder for use in a chained invocation

addAllActiveCooldownListeners

public final ImmutableCooldownConfiguration.Builder<C> addAllActiveCooldownListeners(Iterable<? extends CooldownActiveListener<C>> elements)

Adds elements to activeCooldownListeners list.

Specified by:

addAllActiveCooldownListeners in interface ImmutableCooldownConfiguration.BuildFinal<C>

Parameters:

elements - An iterable of activeCooldownListeners elements

Returns:

this builder for use in a chained invocation

addCreationListener

public final ImmutableCooldownConfiguration.Builder<C> addCreationListener(CooldownCreationListener<C> element)

Adds one element to creationListeners list.

Specified by:

addCreationListener in interface ImmutableCooldownConfiguration.BuildFinal<C>

Parameters:

element - A creationListeners element

Returns:

this builder for use in a chained invocation

addCreationListeners

@SafeVarargs
public final ImmutableCooldownConfiguration.Builder<C> addCreationListeners(CooldownCreationListener<C>... elements)

Adds elements to creationListeners list.

Specified by:

addCreationListeners in interface ImmutableCooldownConfiguration.BuildFinal<C>

Parameters:

elements - An array of creationListeners elements

Returns:

this builder for use in a chained invocation

addAllCreationListeners

public final ImmutableCooldownConfiguration.Builder<C> addAllCreationListeners(Iterable<? extends CooldownCreationListener<C>> elements)

Adds elements to creationListeners list.

Specified by:

addAllCreationListeners in interface ImmutableCooldownConfiguration.BuildFinal<C>

Parameters:

elements - An iterable of creationListeners elements

Returns:

this builder for use in a chained invocation

bypassCooldown

public final ImmutableCooldownConfiguration.Builder<C> bypassCooldown(@NonNull Predicate<CommandContext<C>> bypassCooldown)

Initializes the value for the bypassCooldown attribute.

If not set, this attribute will have a default value as returned by the initializer of bypassCooldown.

Specified by:

bypassCooldown in interface ImmutableCooldownConfiguration.BuildFinal<C>

Parameters:

bypassCooldown - The value for bypassCooldown

Returns:

this builder for use in a chained invocation

clock

public final ImmutableCooldownConfiguration.Builder<C> clock(@NonNull Clock clock)

Initializes the value for the clock attribute.

If not set, this attribute will have a default value as returned by the initializer of clock.

Specified by:

clock in interface ImmutableCooldownConfiguration.BuildFinal<C>

Parameters:

clock - The value for clock

Returns:

this builder for use in a chained invocation

profileFactory

public final ImmutableCooldownConfiguration.Builder<C> profileFactory(@NonNull CooldownProfileFactory profileFactory)

Initializes the value for the profileFactory attribute.

If not set, this attribute will have a default value as returned by the initializer of profileFactory.

Specified by:

profileFactory in interface ImmutableCooldownConfiguration.BuildFinal<C>

Parameters:

profileFactory - The value for profileFactory

Returns:

this builder for use in a chained invocation

fallbackGroup

public final ImmutableCooldownConfiguration.Builder<C> fallbackGroup(@NonNull Function<Command<C>,CooldownGroup> fallbackGroup)

Initializes the value for the fallbackGroup attribute.

If not set, this attribute will have a default value as returned by the initializer of fallbackGroup.

Specified by:

fallbackGroup in interface ImmutableCooldownConfiguration.BuildFinal<C>

Parameters:

fallbackGroup - The value for fallbackGroup

Returns:

this builder for use in a chained invocation

build

public ImmutableCooldownConfiguration<C> build()

Builds a new ImmutableCooldownConfiguration.

Specified by:

build in interface ImmutableCooldownConfiguration.BuildFinal<C>

Returns:

An immutable instance of CooldownConfiguration

Throws:

IllegalStateException - if any required attributes are missing