Package xyz.srnyx.annoyingapi.options

Class MessagesOptions

java.lang.Object

xyz.srnyx.javautilities.parents.Stringable

xyz.srnyx.annoyingapi.options.MessagesOptions

public class MessagesOptions
extends xyz.srnyx.javautilities.parents.Stringable

Represents the options for the AnnoyingPlugin.messages file

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MessagesOptions.MessageKeys	A class to hold the different default AnnoyingPlugin.messages keys

Field Summary

Fields

Modifier and Type	Field	Description
@NotNull String	fileName	OPTIONAL The file name of the messages file (usually messages.yml)
AnnoyingResource.Options	fileOptions	OPTIONAL The options for the messages file
@NotNull MessagesOptions.MessageKeys	keys	OPTIONAL The different message keys for some default messages in the messages file

Constructor Summary

Constructors

Constructor	Description
MessagesOptions()	Constructs a new MessagesOptions instance with default values

Method Summary

Modifier and Type	Method	Description
@NotNull MessagesOptions	fileName(@NotNull String fileName)	Sets fileName
@NotNull MessagesOptions	fileOptions(@NotNull Consumer<AnnoyingResource.Options> consumer)	Sets fileOptions using the specified Consumer
@NotNull MessagesOptions	fileOptions(AnnoyingResource.Options fileOptions)	Sets fileOptions
@NotNull MessagesOptions	keys(@NotNull Consumer<MessagesOptions.MessageKeys> consumer)	Sets keys
@NotNull MessagesOptions	keys(@NotNull MessagesOptions.MessageKeys keys)	Sets keys
static @NotNull MessagesOptions	load(@NotNull org.bukkit.configuration.ConfigurationSection section)	Loads the options from the specified ConfigurationSection

Methods inherited from class xyz.srnyx.javautilities.parents.Stringable

toString, toString, toString, toString, toString

Methods inherited from class java.lang.Object

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

Field Details

fileName

@NotNull
public @NotNull String fileName

OPTIONAL The file name of the messages file (usually messages.yml)

If not specified, no messages will be loaded (plugin will still enable)

fileOptions

@Nullable
public AnnoyingResource.Options fileOptions

OPTIONAL The options for the messages file

If not specified, the default options will be used

keys

@NotNull
public @NotNull MessagesOptions.MessageKeys keys

OPTIONAL The different message keys for some default messages in the messages file

Constructor Details

MessagesOptions

public MessagesOptions()

Constructs a new MessagesOptions instance with default values

Method Details

load

@NotNull
public static @NotNull MessagesOptions load(@NotNull
 @NotNull org.bukkit.configuration.ConfigurationSection section)

Loads the options from the specified ConfigurationSection

Parameters:

section - the section to load the options from

Returns:

the loaded options

fileName

@NotNull
public @NotNull MessagesOptions fileName(@NotNull
 @NotNull String fileName)

Sets fileName

Parameters:

fileName - the new fileName

Returns:

the MessagesOptions instance for chaining

fileOptions

@NotNull
public @NotNull MessagesOptions fileOptions(@Nullable
 AnnoyingResource.Options fileOptions)

Sets fileOptions

Parameters:

fileOptions - the new fileOptions

Returns:

the MessagesOptions instance for chaining

fileOptions

@NotNull
public @NotNull MessagesOptions fileOptions(@NotNull
 @NotNull Consumer<AnnoyingResource.Options> consumer)

Sets fileOptions using the specified Consumer

Parameters:

consumer - the consumer to accept the new fileOptions

Returns:

the MessagesOptions instance for chaining

keys

@NotNull
public @NotNull MessagesOptions keys(@NotNull
 @NotNull MessagesOptions.MessageKeys keys)

Sets keys

Parameters:

keys - the new keys

Returns:

the MessagesOptions instance for chaining

keys

@NotNull
public @NotNull MessagesOptions keys(@NotNull
 @NotNull Consumer<MessagesOptions.MessageKeys> consumer)

Sets keys

Parameters:

consumer - the consumer to accept the new keys

Returns:

the MessagesOptions instance for chaining