Package org.incendo.cloud.minecraft.extras

Interface ImmutableMinecraftHelp.BuildFinal<C>

All Known Implementing Classes:

ImmutableMinecraftHelp.Builder

Enclosing class:

ImmutableMinecraftHelp<C>

@Generated(from="MinecraftHelp",
           generator="Immutables")
public static interface ImmutableMinecraftHelp.BuildFinal<C>

Method Summary

Modifier and Type	Method	Description
ImmutableMinecraftHelp<C>	build()	Builds a new ImmutableMinecraftHelp.
ImmutableMinecraftHelp.BuildFinal<C>	colors(@NonNull MinecraftHelp.HelpColors colors)	Initializes the value for the colors attribute.
ImmutableMinecraftHelp.BuildFinal<C>	commandFilter(@NonNull CommandPredicate<C> commandFilter)	Initializes the value for the commandFilter attribute.
ImmutableMinecraftHelp.BuildFinal<C>	descriptionDecorator(@NonNull MinecraftHelp.DescriptionDecorator<C> descriptionDecorator)	Initializes the value for the descriptionDecorator attribute.
ImmutableMinecraftHelp.BuildFinal<C>	headerFooterLength(@org.checkerframework.checker.index.qual.NonNegative int headerFooterLength)	Initializes the value for the headerFooterLength attribute.
ImmutableMinecraftHelp.BuildFinal<C>	maxResultsPerPage(@org.checkerframework.checker.index.qual.NonNegative int maxResultsPerPage)	Initializes the value for the maxResultsPerPage attribute.
ImmutableMinecraftHelp.BuildFinal<C>	messageProvider(@NonNull MinecraftHelp.MessageProvider<C> messageProvider)	Initializes the value for the messageProvider attribute.
ImmutableMinecraftHelp.BuildFinal<C>	messages(String key, String value)	Put one entry to the messages map.
ImmutableMinecraftHelp.BuildFinal<C>	messages(Map.Entry<String,? extends String> entry)	Put one entry to the messages map.
ImmutableMinecraftHelp.BuildFinal<C>	messages(Map<String,? extends String> entries)	Put all mappings from the specified map as entries to messages map.

Method Details

commandFilter

ImmutableMinecraftHelp.BuildFinal<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.

Parameters:

commandFilter - The value for commandFilter

Returns:

this builder for use in a chained invocation

descriptionDecorator

ImmutableMinecraftHelp.BuildFinal<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.

Parameters:

descriptionDecorator - The value for descriptionDecorator

Returns:

this builder for use in a chained invocation

messages

ImmutableMinecraftHelp.BuildFinal<C> messages(String key,
 String value)

Put one entry to the messages map.

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

ImmutableMinecraftHelp.BuildFinal<C> messages(Map.Entry<String,? extends String> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

messages

ImmutableMinecraftHelp.BuildFinal<C> messages(Map<String,? extends String> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

messageProvider

ImmutableMinecraftHelp.BuildFinal<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.

Parameters:

messageProvider - The value for messageProvider

Returns:

this builder for use in a chained invocation

colors

ImmutableMinecraftHelp.BuildFinal<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.

Parameters:

colors - The value for colors

Returns:

this builder for use in a chained invocation

headerFooterLength

ImmutableMinecraftHelp.BuildFinal<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.

Parameters:

headerFooterLength - The value for headerFooterLength

Returns:

this builder for use in a chained invocation

maxResultsPerPage

ImmutableMinecraftHelp.BuildFinal<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.

Parameters:

maxResultsPerPage - The value for maxResultsPerPage

Returns:

this builder for use in a chained invocation

build

ImmutableMinecraftHelp<C> build()

Builds a new ImmutableMinecraftHelp.

Returns:

An immutable instance of MinecraftHelp

Throws:

IllegalStateException - if any required attributes are missing