Package xyz.srnyx.annoyingapi.file
Class AnnoyingFile<T extends AnnoyingFile<T>>
- java.lang.Object
-
- org.bukkit.configuration.MemorySection
-
- org.bukkit.configuration.MemoryConfiguration
-
- org.bukkit.configuration.file.FileConfiguration
-
- org.bukkit.configuration.file.YamlConfiguration
-
- xyz.srnyx.annoyingapi.file.AnnoyingFile<T>
-
- Type Parameters:
T- the type of theAnnoyingFileinstance
- All Implemented Interfaces:
org.bukkit.configuration.Configuration,org.bukkit.configuration.ConfigurationSection
- Direct Known Subclasses:
AnnoyingData,AnnoyingResource
public class AnnoyingFile<T extends AnnoyingFile<T>> extends org.bukkit.configuration.file.YamlConfigurationRepresents a file in the plugin's folder- See Also:
AnnoyingResource,AnnoyingData
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classAnnoyingFile.Options<G extends AnnoyingFile.Options<G>>A class to hold the options for a file
Default options:AnnoyingFile.Options.canBeEmpty=trueAnnoyingFile.Options.replace=false
-
Field Summary
Fields Modifier and Type Field Description @NotNull java.io.FilefileTheFilefor the fileprotected @NotNull AnnoyingFile.Options<?>fileOptionsTheAnnoyingFile.Optionsfor the file@NotNull AnnoyingPluginpluginTheAnnoyingPlugininstance-
Fields inherited from class org.bukkit.configuration.file.YamlConfiguration
BLANK_CONFIG, COMMENT_PREFIX
-
-
Constructor Summary
Constructors Constructor Description AnnoyingFile(@NotNull AnnoyingPlugin plugin, @NotNull java.io.File file)Constructs a newAnnoyingFileAnnoyingFile(@NotNull AnnoyingPlugin plugin, @NotNull java.io.File file, @Nullable AnnoyingFile.Options<?> fileOptions)Constructs a newAnnoyingFileAnnoyingFile(@NotNull AnnoyingPlugin plugin, @NotNull java.lang.String path)Constructs a newAnnoyingFileAnnoyingFile(@NotNull AnnoyingPlugin plugin, @NotNull java.lang.String path, @Nullable AnnoyingFile.Options<?> fileOptions)Constructs a newAnnoyingFile
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcreate()Creates thefilebooleandelete()Deletes thefile, won't fail silentlybooleandelete(boolean silentFail)Deletes thefile<G> @NotNull java.util.Optional<G>getAttributeModifier(@NotNull java.lang.String path)1.9+Gets anAttributeModifierfrom the path.@NotNull java.util.Optional<org.bukkit.configuration.ConfigurationSection>getConfigurationSectionOptional(@NotNull java.lang.String path)Get aConfigurationSectionfrom the path in anOptional<G> @NotNull java.util.Optional<G>getDef(@NotNull java.lang.String path)Gets the default value from the path@Nullable org.bukkit.inventory.ItemStackgetItemStack(@NotNull java.lang.String path)Gets anItemStackfrom the path.@Nullable org.bukkit.inventory.ItemStackgetItemStack(@NotNull java.lang.String path, @Nullable org.bukkit.inventory.ItemStack def)Gets anItemStackfrom the path.@NotNull java.util.Optional<org.bukkit.inventory.ItemStack>getItemStackOptional(@NotNull java.lang.String path)Gets anItemStackfrom the path.@NotNull java.util.Optional<PlayableSound>getPlayableSound(@NotNull java.lang.String path)Gets aPlayableSoundfrom the path.@NotNull java.util.Optional<org.bukkit.potion.PotionEffect>getPotionEffect(@NotNull java.lang.String path)Gets aPotionEffectfrom the path.@NotNull java.util.Optional<org.bukkit.inventory.Recipe>getRecipe(@NotNull java.lang.String path)Gets aRecipefrom the YAML.@NotNull java.util.Optional<org.bukkit.inventory.Recipe>getRecipe(@NotNull java.lang.String path, @Nullable java.util.function.UnaryOperator<org.bukkit.inventory.ItemStack> itemFunction)Gets aRecipefrom the YAML.@NotNull java.util.Optional<org.bukkit.inventory.Recipe>getRecipe(@NotNull java.lang.String path, @Nullable java.util.function.UnaryOperator<org.bukkit.inventory.ItemStack> itemFunction, @Nullable java.lang.String name)Gets aRecipefrom the YAML.@NotNull java.util.Optional<org.bukkit.Sound>getSound(@NotNull java.lang.String path)Gets aSoundfrom the pathbooleanload()Loads the YAML from the path.voidlog(@NotNull java.util.logging.Level level, @Nullable java.lang.String key, @NotNull java.lang.String message)Sends a formatted log message to the console Sends a formatted warning message to the consolebooleansave()Saves the YAML to thefileTsetChain(@NotNull java.lang.String path, @Nullable java.lang.Object value)Sets a value in the YAML and returns theAnnoyingFileinstancebooleansetSave(@NotNull java.lang.String path, @Nullable java.lang.Object value)Sets a value in the YAML and thensavesthe file@NotNull java.lang.StringtoString()-
Methods inherited from class org.bukkit.configuration.file.YamlConfiguration
buildHeader, convertMapsToSections, loadConfiguration, loadConfiguration, loadConfiguration, loadFromString, options, parseHeader, saveToString
-
Methods inherited from class org.bukkit.configuration.file.FileConfiguration
load, load, load, load, save, save
-
Methods inherited from class org.bukkit.configuration.MemoryConfiguration
addDefault, addDefaults, addDefaults, getDefaults, getParent, setDefaults
-
Methods inherited from class org.bukkit.configuration.MemorySection
contains, createPath, createPath, createSection, createSection, get, get, getBoolean, getBoolean, getBooleanList, getByteList, getCharacterList, getColor, getColor, getConfigurationSection, getCurrentPath, getDefault, getDefaultSection, getDouble, getDouble, getDoubleList, getFloatList, getInt, getInt, getIntegerList, getKeys, getList, getList, getLong, getLong, getLongList, getMapList, getName, getOfflinePlayer, getOfflinePlayer, getRoot, getShortList, getString, getString, getStringList, getValues, getVector, getVector, isBoolean, isColor, isConfigurationSection, isDouble, isInt, isItemStack, isList, isLong, isOfflinePlayer, isPrimitiveWrapper, isSet, isString, isVector, mapChildrenKeys, mapChildrenValues, set
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.bukkit.configuration.ConfigurationSection
contains, createSection, createSection, get, get, getBoolean, getBoolean, getBooleanList, getByteList, getCharacterList, getColor, getColor, getConfigurationSection, getCurrentPath, getDefaultSection, getDouble, getDouble, getDoubleList, getFloatList, getInt, getInt, getIntegerList, getKeys, getList, getList, getLong, getLong, getLongList, getMapList, getName, getOfflinePlayer, getOfflinePlayer, getRoot, getShortList, getString, getString, getStringList, getValues, getVector, getVector, isBoolean, isColor, isConfigurationSection, isDouble, isInt, isItemStack, isList, isLong, isOfflinePlayer, isSet, isString, isVector, set
-
-
-
-
Field Detail
-
plugin
@NotNull public final @NotNull AnnoyingPlugin plugin
TheAnnoyingPlugininstance
-
file
@NotNull public final @NotNull java.io.File file
TheFilefor the file
-
fileOptions
@NotNull protected final @NotNull AnnoyingFile.Options<?> fileOptions
TheAnnoyingFile.Optionsfor the file
-
-
Constructor Detail
-
AnnoyingFile
public AnnoyingFile(@NotNull @NotNull AnnoyingPlugin plugin, @NotNull @NotNull java.io.File file, @Nullable @Nullable AnnoyingFile.Options<?> fileOptions)Constructs a newAnnoyingFile- Parameters:
plugin-pluginfile-filefileOptions-fileOptions
-
AnnoyingFile
public AnnoyingFile(@NotNull @NotNull AnnoyingPlugin plugin, @NotNull @NotNull java.io.File file)Constructs a newAnnoyingFile
-
AnnoyingFile
public AnnoyingFile(@NotNull @NotNull AnnoyingPlugin plugin, @NotNull @NotNull java.lang.String path, @Nullable @Nullable AnnoyingFile.Options<?> fileOptions)Constructs a newAnnoyingFile- Parameters:
plugin-pluginpath- the path to the file (relative to the plugin's folder)fileOptions-fileOptions
-
AnnoyingFile
public AnnoyingFile(@NotNull @NotNull AnnoyingPlugin plugin, @NotNull @NotNull java.lang.String path)Constructs a newAnnoyingFile- Parameters:
plugin-pluginpath- the path to the file (relative to the plugin's folder)
-
-
Method Detail
-
toString
@NotNull public @NotNull java.lang.String toString()
- Overrides:
toStringin classorg.bukkit.configuration.MemorySection
-
create
public void create()
Creates thefile
-
load
public boolean load()
Loads the YAML from the path. If the file doesn't exist andcan'tbe empty, an emptyYamlConfigurationwill be used- Returns:
- whether the file was loaded successfully
-
delete
public boolean delete(boolean silentFail)
Deletes thefile- Parameters:
silentFail- whether to fail silently- Returns:
- whether the file was deleted successfully
- See Also:
delete()
-
delete
public boolean delete()
Deletes thefile, won't fail silently- Returns:
- whether the file was deleted successfully
- See Also:
delete(boolean)
-
setChain
@NotNull public T setChain(@NotNull @NotNull java.lang.String path, @Nullable @Nullable java.lang.Object value)
Sets a value in the YAML and returns theAnnoyingFileinstance- Parameters:
path- the path to the nodevalue- the value to set the node to- Returns:
- the
AnnoyingFileinstance
-
setSave
public boolean setSave(@NotNull @NotNull java.lang.String path, @Nullable @Nullable java.lang.Object value)Sets a value in the YAML and thensavesthe file- Parameters:
path- the path to the nodevalue- the value to set the node to- Returns:
- whether the file was saved successfully
-
save
public boolean save()
Saves the YAML to thefile- Returns:
- whether the file was saved successfully
-
log
public void log(@NotNull @NotNull java.util.logging.Level level, @Nullable @Nullable java.lang.String key, @NotNull @NotNull java.lang.String message)Sends a formatted log message to the console Sends a formatted warning message to the console- Parameters:
level- theLevelof the messagekey- the key of the node that the message is about (nullif it's not about a node)message- the message to send
-
getDef
@NotNull public <G> @NotNull java.util.Optional<G> getDef(@NotNull @NotNull java.lang.String path)Gets the default value from the path- Type Parameters:
G- the type of the default value- Parameters:
path- the path to the node- Returns:
- the default value or empty if it doesn't exist
-
getConfigurationSectionOptional
@NotNull public @NotNull java.util.Optional<org.bukkit.configuration.ConfigurationSection> getConfigurationSectionOptional(@NotNull @NotNull java.lang.String path)Get aConfigurationSectionfrom the path in anOptional- Parameters:
path- the path to the node- Returns:
- the
ConfigurationSectionor empty if it doesn't exist
-
getSound
@NotNull public @NotNull java.util.Optional<org.bukkit.Sound> getSound(@NotNull @NotNull java.lang.String path)Gets aSoundfrom the path- Parameters:
path- the path to the node- Returns:
- the
Soundor empty if it's invalid
-
getPlayableSound
@NotNull public @NotNull java.util.Optional<PlayableSound> getPlayableSound(@NotNull @NotNull java.lang.String path)
Gets aPlayableSoundfrom the path. See the wiki for more information- Parameters:
path- the path to the node- Returns:
- the
PlayableSoundor empty if it's invalid
-
getPotionEffect
@NotNull public @NotNull java.util.Optional<org.bukkit.potion.PotionEffect> getPotionEffect(@NotNull @NotNull java.lang.String path)Gets aPotionEffectfrom the path. See the wiki for more information- Parameters:
path- the path to the node- Returns:
- the
PotionEffector empty if it's invalid
-
getAttributeModifier
@NotNull public <G> @NotNull java.util.Optional<G> getAttributeModifier(@NotNull @NotNull java.lang.String path)- Type Parameters:
G- theAttributeModifierclass- Parameters:
path- the path to the node- Returns:
- the
AttributeModifieror empty if it's invalid
-
getItemStack
@Nullable public @Nullable org.bukkit.inventory.ItemStack getItemStack(@NotNull @NotNull java.lang.String path)Gets anItemStackfrom the path. See the wiki for more information- Specified by:
getItemStackin interfaceorg.bukkit.configuration.ConfigurationSection- Overrides:
getItemStackin classorg.bukkit.configuration.MemorySection- Parameters:
path- the path to the node- Returns:
- the
ItemStackornullif it's invalid
-
getItemStack
@Nullable public @Nullable org.bukkit.inventory.ItemStack getItemStack(@NotNull @NotNull java.lang.String path, @Nullable @Nullable org.bukkit.inventory.ItemStack def)Gets anItemStackfrom the path. See the wiki for more information- Specified by:
getItemStackin interfaceorg.bukkit.configuration.ConfigurationSection- Overrides:
getItemStackin classorg.bukkit.configuration.MemorySection- Parameters:
path- the path to the nodedef- the default value- Returns:
- the
ItemStackordefif it's invalid
-
getItemStackOptional
@NotNull public @NotNull java.util.Optional<org.bukkit.inventory.ItemStack> getItemStackOptional(@NotNull @NotNull java.lang.String path)Gets anItemStackfrom the path. See the wiki for more information- Parameters:
path- the path to the node- Returns:
- the
ItemStackor empty if it's invalid
-
getRecipe
@NotNull public @NotNull java.util.Optional<org.bukkit.inventory.Recipe> getRecipe(@NotNull @NotNull java.lang.String path)Gets aRecipefrom the YAML. See the wiki for more information- Parameters:
path- the path to get the recipe from- Returns:
- the
Recipeornullif it doesn't exist / is invalid / something went wrong
-
getRecipe
@NotNull public @NotNull java.util.Optional<org.bukkit.inventory.Recipe> getRecipe(@NotNull @NotNull java.lang.String path, @Nullable @Nullable java.util.function.UnaryOperator<org.bukkit.inventory.ItemStack> itemFunction)Gets aRecipefrom the YAML. See the wiki for more information- Parameters:
path- the path to get the recipe fromitemFunction- the function to apply to theItemStackbefore returning it- Returns:
- the
Recipeor empty if it's invalid
-
getRecipe
@NotNull public @NotNull java.util.Optional<org.bukkit.inventory.Recipe> getRecipe(@NotNull @NotNull java.lang.String path, @Nullable @Nullable java.util.function.UnaryOperator<org.bukkit.inventory.ItemStack> itemFunction, @Nullable @Nullable java.lang.String name)Gets aRecipefrom the YAML. See the wiki for more information- Parameters:
path- the path to get the recipe fromitemFunction- the function to apply to theItemStackbefore returning itname- the name of the recipe (only used in 1.12+ for theNamespacedKey), ornullto use the node name- Returns:
- the
Recipeor thedefif it's invalid
-
-