Package xyz.srnyx.annoyingapi.options

Class MessagesOptions.MessageKeys

java.lang.Object

xyz.srnyx.javautilities.parents.Stringable

xyz.srnyx.annoyingapi.options.MessagesOptions.MessageKeys

Enclosing class:

MessagesOptions

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

A class to hold the different default AnnoyingPlugin.messages keys

Field Summary

Fields

Modifier and Type	Field	Description
@NotNull String	disabledCommand	OPTIONAL The AnnoyingPlugin.messages key for the plugin's "disabled command" message
@NotNull String	format	OPTIONAL The AnnoyingPlugin.messages key for the plugin's format
@NotNull String	globalPlaceholders	OPTIONAL The AnnoyingPlugin.messages key for the plugin's global placeholders
@NotNull String	invalidArgument	OPTIONAL The AnnoyingPlugin.messages key for the plugin's "invalid argument" message
@NotNull String	invalidArguments	OPTIONAL The AnnoyingPlugin.messages key for the plugin's "invalid arguments" message
@NotNull String	noPermission	OPTIONAL The AnnoyingPlugin.messages key for the plugin's "no permission" message
@NotNull String	playerOnly	OPTIONAL The AnnoyingPlugin.messages key for the plugin's "player-only" message
@NotNull String	splitterJson	OPTIONAL The AnnoyingPlugin.messages key for the plugin's JSON component splitter
@NotNull String	splitterPlaceholder	OPTIONAL The AnnoyingPlugin.messages key for the plugin's placeholder component splitter
@NotNull String	updateAvailable	OPTIONAL The key for the message sent in the console when an update is available for the plugin

Constructor Summary

Constructors

Constructor	Description
MessageKeys()	Creates a new MessagesOptions.MessageKeys with the default values

Method Summary

Modifier and Type	Method	Description
@NotNull MessagesOptions.MessageKeys	disabledCommand(@NotNull String disabledCommand)	Sets disabledCommand
@NotNull MessagesOptions.MessageKeys	format(@NotNull String format)	Sets format
@NotNull MessagesOptions.MessageKeys	globalPlaceholders(@NotNull String globalPlaceholders)	Sets globalPlaceholders
@NotNull MessagesOptions.MessageKeys	invalidArgument(@NotNull String invalidArgument)	Sets invalidArgument
@NotNull MessagesOptions.MessageKeys	invalidArguments(@NotNull String invalidArguments)	Sets invalidArguments
static MessagesOptions.MessageKeys	load(@NotNull org.bukkit.configuration.ConfigurationSection section)	Loads the MessagesOptions.MessageKeys from the specified ConfigurationSection
@NotNull MessagesOptions.MessageKeys	noPermission(@NotNull String noPermission)	Sets noPermission
@NotNull MessagesOptions.MessageKeys	playerOnly(@NotNull String playerOnly)	Sets playerOnly
@NotNull MessagesOptions.MessageKeys	splitterJson(@NotNull String splitterJson)	Sets splitterJson
@NotNull MessagesOptions.MessageKeys	splitterPlaceholder(@NotNull String splitterPlaceholder)	Sets splitterPlaceholder
@NotNull MessagesOptions.MessageKeys	updateAvailable(@NotNull String updateAvailable)	Sets updateAvailable

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

format

@NotNull
public @NotNull String format

OPTIONAL The AnnoyingPlugin.messages key for the plugin's format

globalPlaceholders

@NotNull
public @NotNull String globalPlaceholders

OPTIONAL The AnnoyingPlugin.messages key for the plugin's global placeholders

See Also:

• AnnoyingPlugin.globalPlaceholders

splitterJson

@NotNull
public @NotNull String splitterJson

OPTIONAL The AnnoyingPlugin.messages key for the plugin's JSON component splitter

splitterPlaceholder

@NotNull
public @NotNull String splitterPlaceholder

OPTIONAL The AnnoyingPlugin.messages key for the plugin's placeholder component splitter

updateAvailable

@NotNull
public @NotNull String updateAvailable

OPTIONAL The key for the message sent in the console when an update is available for the plugin

noPermission

@NotNull
public @NotNull String noPermission

OPTIONAL The AnnoyingPlugin.messages key for the plugin's "no permission" message

playerOnly

@NotNull
public @NotNull String playerOnly

OPTIONAL The AnnoyingPlugin.messages key for the plugin's "player-only" message

invalidArgument

@NotNull
public @NotNull String invalidArgument

OPTIONAL The AnnoyingPlugin.messages key for the plugin's "invalid argument" message

This should contain %argument% for the invalid argument

invalidArguments

@NotNull
public @NotNull String invalidArguments

OPTIONAL The AnnoyingPlugin.messages key for the plugin's "invalid arguments" message

disabledCommand

@NotNull
public @NotNull String disabledCommand

OPTIONAL The AnnoyingPlugin.messages key for the plugin's "disabled command" message

Constructor Details

MessageKeys

public MessageKeys()

Creates a new MessagesOptions.MessageKeys with the default values

Method Details

load

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

Loads the MessagesOptions.MessageKeys from the specified ConfigurationSection

Parameters:

section - the section to load the MessagesOptions.MessageKeys from

Returns:

the loaded MessagesOptions.MessageKeys

format

@NotNull
public @NotNull MessagesOptions.MessageKeys format(@NotNull
 @NotNull String format)

Sets format

Parameters:

format - the new format

Returns:

the MessagesOptions.MessageKeys instance for chaining

globalPlaceholders

@NotNull
public @NotNull MessagesOptions.MessageKeys globalPlaceholders(@NotNull
 @NotNull String globalPlaceholders)

Sets globalPlaceholders

Parameters:

globalPlaceholders - the new globalPlaceholders

Returns:

the MessagesOptions.MessageKeys instance for chaining

splitterJson

@NotNull
public @NotNull MessagesOptions.MessageKeys splitterJson(@NotNull
 @NotNull String splitterJson)

Sets splitterJson

Parameters:

splitterJson - the new splitterJson

Returns:

the MessagesOptions.MessageKeys instance for chaining

splitterPlaceholder

@NotNull
public @NotNull MessagesOptions.MessageKeys splitterPlaceholder(@NotNull
 @NotNull String splitterPlaceholder)

Sets splitterPlaceholder

Parameters:

splitterPlaceholder - the new splitterPlaceholder

Returns:

the MessagesOptions.MessageKeys instance for chaining

updateAvailable

@NotNull
public @NotNull MessagesOptions.MessageKeys updateAvailable(@NotNull
 @NotNull String updateAvailable)

Sets updateAvailable

Parameters:

updateAvailable - the new updateAvailable

Returns:

the MessagesOptions.MessageKeys instance for chaining

noPermission

@NotNull
public @NotNull MessagesOptions.MessageKeys noPermission(@NotNull
 @NotNull String noPermission)

Sets noPermission

Parameters:

noPermission - the new noPermission

Returns:

the MessagesOptions.MessageKeys instance for chaining

playerOnly

@NotNull
public @NotNull MessagesOptions.MessageKeys playerOnly(@NotNull
 @NotNull String playerOnly)

Sets playerOnly

Parameters:

playerOnly - the new playerOnly

Returns:

the MessagesOptions.MessageKeys instance for chaining

invalidArgument

@NotNull
public @NotNull MessagesOptions.MessageKeys invalidArgument(@NotNull
 @NotNull String invalidArgument)

Sets invalidArgument

Parameters:

invalidArgument - the new invalidArgument

Returns:

the MessagesOptions.MessageKeys instance for chaining

invalidArguments

@NotNull
public @NotNull MessagesOptions.MessageKeys invalidArguments(@NotNull
 @NotNull String invalidArguments)

Sets invalidArguments

Parameters:

invalidArguments - the new invalidArguments

Returns:

the MessagesOptions.MessageKeys instance for chaining

disabledCommand

@NotNull
public @NotNull MessagesOptions.MessageKeys disabledCommand(@NotNull
 @NotNull String disabledCommand)

Sets disabledCommand

Parameters:

disabledCommand - the new disabledCommand

Returns:

the MessagesOptions.MessageKeys instance for chaining