Package org.incendo.cloud.processors.cooldown

Class ImmutableCooldownInstance.Builder

java.lang.Object

org.incendo.cloud.processors.cooldown.ImmutableCooldownInstance.Builder

All Implemented Interfaces:

ImmutableCooldownInstance.BuildFinal, ImmutableCooldownInstance.CreationTimeBuildStage, ImmutableCooldownInstance.DurationBuildStage, ImmutableCooldownInstance.GroupBuildStage, ImmutableCooldownInstance.ProfileBuildStage

Enclosing class:

ImmutableCooldownInstance

public static final class ImmutableCooldownInstance.Builder
extends Object
implements ImmutableCooldownInstance.ProfileBuildStage, ImmutableCooldownInstance.GroupBuildStage, ImmutableCooldownInstance.DurationBuildStage, ImmutableCooldownInstance.CreationTimeBuildStage, ImmutableCooldownInstance.BuildFinal

Builds instances of type ImmutableCooldownInstance. 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
ImmutableCooldownInstance	build()	Builds a new ImmutableCooldownInstance.
final ImmutableCooldownInstance.Builder	creationTime(@NonNull Instant creationTime)	Initializes the value for the creationTime attribute.
final ImmutableCooldownInstance.Builder	duration(@NonNull Duration duration)	Initializes the value for the duration attribute.
final ImmutableCooldownInstance.Builder	group(@NonNull CooldownGroup group)	Initializes the value for the group attribute.
final ImmutableCooldownInstance.Builder	profile(@NonNull CooldownProfile profile)	Initializes the value for the profile attribute.

Methods inherited from class java.lang.Object

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

Method Details

profile

public final ImmutableCooldownInstance.Builder profile(@NonNull CooldownProfile profile)

Initializes the value for the profile attribute.

Specified by:

profile in interface ImmutableCooldownInstance.ProfileBuildStage

Parameters:

profile - The value for profile

Returns:

this builder for use in a chained invocation

group

public final ImmutableCooldownInstance.Builder group(@NonNull CooldownGroup group)

Initializes the value for the group attribute.

Specified by:

group in interface ImmutableCooldownInstance.GroupBuildStage

Parameters:

group - The value for group

Returns:

this builder for use in a chained invocation

duration

public final ImmutableCooldownInstance.Builder duration(@NonNull Duration duration)

Initializes the value for the duration attribute.

Specified by:

duration in interface ImmutableCooldownInstance.DurationBuildStage

Parameters:

duration - The value for duration

Returns:

this builder for use in a chained invocation

creationTime

public final ImmutableCooldownInstance.Builder creationTime(@NonNull Instant creationTime)

Initializes the value for the creationTime attribute.

Specified by:

creationTime in interface ImmutableCooldownInstance.CreationTimeBuildStage

Parameters:

creationTime - The value for creationTime

Returns:

this builder for use in a chained invocation

build

public ImmutableCooldownInstance build()

Builds a new ImmutableCooldownInstance.

Specified by:

build in interface ImmutableCooldownInstance.BuildFinal

Returns:

An immutable instance of CooldownInstance

Throws:

IllegalStateException - if any required attributes are missing