Package org.incendo.cloud.minecraft.extras

Class ImmutableMinecraftHelp.Builder<C>

java.lang.Object

org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.Builder<C>

All Implemented Interfaces:

ImmutableMinecraftHelp.AudienceProviderBuildStage<C>, ImmutableMinecraftHelp.BuildFinal<C>, ImmutableMinecraftHelp.CommandManagerBuildStage<C>, ImmutableMinecraftHelp.CommandPrefixBuildStage<C>

Enclosing class:

ImmutableMinecraftHelp<C>

@Generated(from="MinecraftHelp",
           generator="Immutables")
public static final class ImmutableMinecraftHelp.Builder<C>
extends Object
implements ImmutableMinecraftHelp.CommandManagerBuildStage<C>, ImmutableMinecraftHelp.AudienceProviderBuildStage<C>, ImmutableMinecraftHelp.CommandPrefixBuildStage<C>, ImmutableMinecraftHelp.BuildFinal<C>

Builds instances of type ImmutableMinecraftHelp. 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 ImmutableMinecraftHelp.Builder<C>	audienceProvider(@NonNull AudienceProvider<C> audienceProvider)	Initializes the value for the audienceProvider attribute.
ImmutableMinecraftHelp<C>	build()	Builds a new ImmutableMinecraftHelp.
final ImmutableMinecraftHelp.Builder<C>	colors(@NonNull MinecraftHelp.HelpColors colors)	Initializes the value for the colors attribute.
final ImmutableMinecraftHelp.Builder<C>	commandFilter(@NonNull CommandPredicate<C> commandFilter)	Initializes the value for the commandFilter attribute.
final ImmutableMinecraftHelp.Builder<C>	commandManager(@NonNull CommandManager<C> commandManager)	Initializes the value for the commandManager attribute.
final ImmutableMinecraftHelp.Builder<C>	commandPrefix(@NonNull String commandPrefix)	Initializes the value for the commandPrefix attribute.
final ImmutableMinecraftHelp.Builder<C>	descriptionDecorator(@NonNull MinecraftHelp.DescriptionDecorator<C> descriptionDecorator)	Initializes the value for the descriptionDecorator attribute.
final ImmutableMinecraftHelp.Builder<C>	headerFooterLength(@org.checkerframework.checker.index.qual.NonNegative int headerFooterLength)	Initializes the value for the headerFooterLength attribute.
final ImmutableMinecraftHelp.Builder<C>	maxResultsPerPage(@org.checkerframework.checker.index.qual.NonNegative int maxResultsPerPage)	Initializes the value for the maxResultsPerPage attribute.
final ImmutableMinecraftHelp.Builder<C>	messageProvider(@NonNull MinecraftHelp.MessageProvider<C> messageProvider)	Initializes the value for the messageProvider attribute.
final ImmutableMinecraftHelp.Builder<C>	messages(String key, String value)	Put one entry to the messages map.
final ImmutableMinecraftHelp.Builder<C>	messages(Map.Entry<String,? extends String> entry)	Put one entry to the messages map.
final ImmutableMinecraftHelp.Builder<C>	messages(Map<String,? extends String> entries)	Put all mappings from the specified map as entries to messages map.

Methods inherited from class java.lang.Object

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

Method Details

commandManager

public final ImmutableMinecraftHelp.Builder<C> commandManager(@NonNull CommandManager<C> commandManager)

Initializes the value for the commandManager attribute.

Specified by:

commandManager in interface ImmutableMinecraftHelp.CommandManagerBuildStage<C>

Parameters:

commandManager - The value for commandManager

Returns:

this builder for use in a chained invocation

audienceProvider

public final ImmutableMinecraftHelp.Builder<C> audienceProvider(@NonNull AudienceProvider<C> audienceProvider)

Initializes the value for the audienceProvider attribute.

Specified by:

audienceProvider in interface ImmutableMinecraftHelp.AudienceProviderBuildStage<C>

Parameters:

audienceProvider - The value for audienceProvider

Returns:

this builder for use in a chained invocation

commandPrefix

public final ImmutableMinecraftHelp.Builder<C> commandPrefix(@NonNull String commandPrefix)

Initializes the value for the commandPrefix attribute.

Specified by:

commandPrefix in interface ImmutableMinecraftHelp.CommandPrefixBuildStage<C>

Parameters:

commandPrefix - The value for commandPrefix

Returns:

this builder for use in a chained invocation

commandFilter

public final ImmutableMinecraftHelp.Builder<C> commandFilter(@NonNull CommandPredicate<C> commandFilter)

Initializes the value for the commandFilter attribute.

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

Specified by:

commandFilter in interface ImmutableMinecraftHelp.BuildFinal<C>

Parameters:

commandFilter - The value for commandFilter

Returns:

this builder for use in a chained invocation

descriptionDecorator

public final ImmutableMinecraftHelp.Builder<C> descriptionDecorator(@NonNull MinecraftHelp.DescriptionDecorator<C> descriptionDecorator)

Initializes the value for the descriptionDecorator attribute.

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

Specified by:

descriptionDecorator in interface ImmutableMinecraftHelp.BuildFinal<C>

Parameters:

descriptionDecorator - The value for descriptionDecorator

Returns:

this builder for use in a chained invocation

messages

public final ImmutableMinecraftHelp.Builder<C> messages(String key,
 String value)

Put one entry to the messages map.

Specified by:

messages in interface ImmutableMinecraftHelp.BuildFinal<C>

Parameters:

key - The key in the messages map

value - The associated value in the messages map

Returns:

this builder for use in a chained invocation

messages

public final ImmutableMinecraftHelp.Builder<C> messages(Map.Entry<String,? extends String> entry)

Put one entry to the messages map. Nulls are not permitted

Specified by:

messages in interface ImmutableMinecraftHelp.BuildFinal<C>

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

messages

public final ImmutableMinecraftHelp.Builder<C> messages(Map<String,? extends String> entries)

Put all mappings from the specified map as entries to messages map. Nulls are not permitted

Specified by:

messages in interface ImmutableMinecraftHelp.BuildFinal<C>

Parameters:

entries - The entries that will be added to the messages map

Returns:

this builder for use in a chained invocation

messageProvider

public final ImmutableMinecraftHelp.Builder<C> messageProvider(@NonNull MinecraftHelp.MessageProvider<C> messageProvider)

Initializes the value for the messageProvider attribute.

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

Specified by:

messageProvider in interface ImmutableMinecraftHelp.BuildFinal<C>

Parameters:

messageProvider - The value for messageProvider

Returns:

this builder for use in a chained invocation

colors

public final ImmutableMinecraftHelp.Builder<C> colors(@NonNull MinecraftHelp.HelpColors colors)

Initializes the value for the colors attribute.

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

Specified by:

colors in interface ImmutableMinecraftHelp.BuildFinal<C>

Parameters:

colors - The value for colors

Returns:

this builder for use in a chained invocation

headerFooterLength

public final ImmutableMinecraftHelp.Builder<C> headerFooterLength(@org.checkerframework.checker.index.qual.NonNegative int headerFooterLength)

Initializes the value for the headerFooterLength attribute.

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

Specified by:

headerFooterLength in interface ImmutableMinecraftHelp.BuildFinal<C>

Parameters:

headerFooterLength - The value for headerFooterLength

Returns:

this builder for use in a chained invocation

maxResultsPerPage

public final ImmutableMinecraftHelp.Builder<C> maxResultsPerPage(@org.checkerframework.checker.index.qual.NonNegative int maxResultsPerPage)

Initializes the value for the maxResultsPerPage attribute.

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

Specified by:

maxResultsPerPage in interface ImmutableMinecraftHelp.BuildFinal<C>

Parameters:

maxResultsPerPage - The value for maxResultsPerPage

Returns:

this builder for use in a chained invocation

build

public ImmutableMinecraftHelp<C> build()

Builds a new ImmutableMinecraftHelp.

Specified by:

build in interface ImmutableMinecraftHelp.BuildFinal<C>

Returns:

An immutable instance of MinecraftHelp

Throws:

IllegalStateException - if any required attributes are missing