Package org.incendo.cloud.processors.cooldown

Class ImmutableCooldown.Builder<C>

java.lang.Object

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

All Implemented Interfaces:

ImmutableCooldown.BuildFinal<C>, ImmutableCooldown.DurationBuildStage<C>

Enclosing class:

ImmutableCooldown<C>

public static final class ImmutableCooldown.Builder<C>
extends Object
implements ImmutableCooldown.DurationBuildStage<C>, ImmutableCooldown.BuildFinal<C>

Builds instances of type ImmutableCooldown. 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
ImmutableCooldown<C>	build()	Builds a new ImmutableCooldown.
final ImmutableCooldown.Builder<C>	duration(@NonNull DurationFunction<C> duration)	Initializes the value for the duration attribute.
final ImmutableCooldown.Builder<C>	group(@Nullable CooldownGroup group)	Initializes the value for the group attribute.

Methods inherited from class java.lang.Object

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

Method Details

duration

public final ImmutableCooldown.Builder<C> duration(@NonNull DurationFunction<C> duration)

Initializes the value for the duration attribute.

Specified by:

duration in interface ImmutableCooldown.DurationBuildStage<C>

Parameters:

duration - The value for duration

Returns:

this builder for use in a chained invocation

group

public final ImmutableCooldown.Builder<C> group(@Nullable CooldownGroup group)

Initializes the value for the group attribute.

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

Specified by:

group in interface ImmutableCooldown.BuildFinal<C>

Parameters:

group - The value for group (can be null)

Returns:

this builder for use in a chained invocation

build

public ImmutableCooldown<C> build()

Builds a new ImmutableCooldown.

Specified by:

build in interface ImmutableCooldown.BuildFinal<C>

Returns:

An immutable instance of Cooldown

Throws:

IllegalStateException - if any required attributes are missing