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.StringableRepresents the options for theAnnoyingPlugin.messagesfile
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMessagesOptions.MessageKeysA class to hold the different defaultAnnoyingPlugin.messageskeys
-
Field Summary
Fields Modifier and Type Field Description @NotNull java.lang.StringfileNameOPTIONALThe file name of the messages file (usuallymessages.yml)AnnoyingResource.OptionsfileOptions@NotNull MessagesOptions.MessageKeyskeysOPTIONALThe different message keys for some default messages in themessages file
-
Constructor Summary
Constructors Constructor Description MessagesOptions()Constructs a newMessagesOptionsinstance with default values
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description @NotNull MessagesOptionsfileName(@NotNull java.lang.String fileName)SetsfileName@NotNull MessagesOptionsfileOptions(@NotNull java.util.function.Consumer<AnnoyingResource.Options> consumer)SetsfileOptionsusing the specifiedConsumer@NotNull MessagesOptionsfileOptions(AnnoyingResource.Options fileOptions)SetsfileOptions@NotNull MessagesOptionskeys(@NotNull java.util.function.Consumer<MessagesOptions.MessageKeys> consumer)Setskeys@NotNull MessagesOptionskeys(@NotNull MessagesOptions.MessageKeys keys)Setskeysstatic @NotNull MessagesOptionsload(@NotNull org.bukkit.configuration.ConfigurationSection section)Loads the options from the specifiedConfigurationSection
-
-
-
Field Detail
-
fileName
@NotNull public @NotNull java.lang.String fileName
OPTIONALThe file name of the messages file (usuallymessages.yml)If not specified, no messages will be loaded (plugin will still enable)
-
fileOptions
@Nullable public AnnoyingResource.Options fileOptions
-
keys
@NotNull public @NotNull MessagesOptions.MessageKeys keys
OPTIONALThe different message keys for some default messages in themessages file
-
-
Constructor Detail
-
MessagesOptions
public MessagesOptions()
Constructs a newMessagesOptionsinstance with default values
-
-
Method Detail
-
load
@NotNull public static @NotNull MessagesOptions load(@NotNull @NotNull org.bukkit.configuration.ConfigurationSection section)
Loads the options from the specifiedConfigurationSection- Parameters:
section- the section to load the options from- Returns:
- the loaded options
-
fileName
@NotNull public @NotNull MessagesOptions fileName(@NotNull @NotNull java.lang.String fileName)
SetsfileName- Parameters:
fileName- the newfileName- Returns:
- the
MessagesOptionsinstance for chaining
-
fileOptions
@NotNull public @NotNull MessagesOptions fileOptions(@Nullable AnnoyingResource.Options fileOptions)
SetsfileOptions- Parameters:
fileOptions- the newfileOptions- Returns:
- the
MessagesOptionsinstance for chaining
-
fileOptions
@NotNull public @NotNull MessagesOptions fileOptions(@NotNull @NotNull java.util.function.Consumer<AnnoyingResource.Options> consumer)
SetsfileOptionsusing the specifiedConsumer- Parameters:
consumer- the consumer to accept the newfileOptions- Returns:
- the
MessagesOptionsinstance for chaining
-
keys
@NotNull public @NotNull MessagesOptions keys(@NotNull @NotNull MessagesOptions.MessageKeys keys)
Setskeys- Parameters:
keys- the newkeys- Returns:
- the
MessagesOptionsinstance for chaining
-
keys
@NotNull public @NotNull MessagesOptions keys(@NotNull @NotNull java.util.function.Consumer<MessagesOptions.MessageKeys> consumer)
Setskeys- Parameters:
consumer- the consumer to accept the newkeys- Returns:
- the
MessagesOptionsinstance for chaining
-
-