Class AnnoyingFile<T extends AnnoyingFile<T>>

  • Type Parameters:
    T - the type of the AnnoyingFile instance
    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.YamlConfiguration
    Represents a file in the plugin's folder
    See Also:
    AnnoyingResource, AnnoyingData
    • Field Summary

      Fields 
      Modifier and Type Field Description
      @NotNull java.io.File file
      The File for the file
      protected @NotNull AnnoyingFile.Options<?> fileOptions
      The AnnoyingFile.Options for the file
      @NotNull AnnoyingPlugin plugin
      The AnnoyingPlugin instance
      • Fields inherited from class org.bukkit.configuration.file.YamlConfiguration

        BLANK_CONFIG, COMMENT_PREFIX
      • Fields inherited from class org.bukkit.configuration.file.FileConfiguration

        SYSTEM_UTF, UTF_BIG, UTF8_OVERRIDE
      • Fields inherited from class org.bukkit.configuration.MemoryConfiguration

        defaults, options
      • Fields inherited from class org.bukkit.configuration.MemorySection

        map
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void create()
      Creates the file
      boolean delete()
      Deletes the file, won't fail silently
      boolean delete​(boolean silentFail)
      Deletes the file
      <G> @NotNull java.util.Optional<G> getAttributeModifier​(@NotNull java.lang.String path)
      1.9+ Gets an AttributeModifier from the path.
      @NotNull java.util.Optional<org.bukkit.configuration.ConfigurationSection> getConfigurationSectionOptional​(@NotNull java.lang.String path)
      Get a ConfigurationSection from the path in an Optional
      <G> @NotNull java.util.Optional<G> getDef​(@NotNull java.lang.String path)
      Gets the default value from the path
      @Nullable org.bukkit.inventory.ItemStack getItemStack​(@NotNull java.lang.String path)
      Gets an ItemStack from the path.
      @Nullable org.bukkit.inventory.ItemStack getItemStack​(@NotNull java.lang.String path, @Nullable org.bukkit.inventory.ItemStack def)
      Gets an ItemStack from the path.
      @NotNull java.util.Optional<org.bukkit.inventory.ItemStack> getItemStackOptional​(@NotNull java.lang.String path)
      Gets an ItemStack from the path.
      @NotNull java.util.Optional<PlayableSound> getPlayableSound​(@NotNull java.lang.String path)
      Gets a PlayableSound from the path.
      @NotNull java.util.Optional<org.bukkit.potion.PotionEffect> getPotionEffect​(@NotNull java.lang.String path)
      Gets a PotionEffect from the path.
      @NotNull java.util.Optional<org.bukkit.inventory.Recipe> getRecipe​(@NotNull java.lang.String path)
      Gets a Recipe from 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 a Recipe from 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 a Recipe from the YAML.
      @NotNull java.util.Optional<org.bukkit.Sound> getSound​(@NotNull java.lang.String path)
      Gets a Sound from the path
      boolean load()
      Loads the YAML from the path.
      void log​(@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 console
      boolean save()
      Saves the YAML to the file
      T setChain​(@NotNull java.lang.String path, @Nullable java.lang.Object value)
      Sets a value in the YAML and returns the AnnoyingFile instance
      boolean setSave​(@NotNull java.lang.String path, @Nullable java.lang.Object value)
      Sets a value in the YAML and then saves the file
      @NotNull java.lang.String toString()  
      • 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
    • Constructor Detail

      • AnnoyingFile

        public AnnoyingFile​(@NotNull
                            @NotNull AnnoyingPlugin plugin,
                            @NotNull
                            @NotNull java.io.File file)
        Constructs a new AnnoyingFile
        Parameters:
        plugin - plugin
        file - file
      • AnnoyingFile

        public AnnoyingFile​(@NotNull
                            @NotNull AnnoyingPlugin plugin,
                            @NotNull
                            @NotNull java.lang.String path,
                            @Nullable
                            @Nullable AnnoyingFile.Options<?> fileOptions)
        Constructs a new AnnoyingFile
        Parameters:
        plugin - plugin
        path - 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 new AnnoyingFile
        Parameters:
        plugin - plugin
        path - the path to the file (relative to the plugin's folder)
    • Method Detail

      • toString

        @NotNull
        public @NotNull java.lang.String toString()
        Overrides:
        toString in class org.bukkit.configuration.MemorySection
      • create

        public void create()
        Creates the file
      • load

        public boolean load()
        Loads the YAML from the path. If the file doesn't exist and can'tbe empty, an empty YamlConfiguration will be used
        Returns:
        whether the file was loaded successfully
      • delete

        public boolean delete​(boolean silentFail)
        Deletes the file
        Parameters:
        silentFail - whether to fail silently
        Returns:
        whether the file was deleted successfully
        See Also:
        delete()
      • delete

        public boolean delete()
        Deletes the file, 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 the AnnoyingFile instance
        Parameters:
        path - the path to the node
        value - the value to set the node to
        Returns:
        the AnnoyingFile instance
      • setSave

        public boolean setSave​(@NotNull
                               @NotNull java.lang.String path,
                               @Nullable
                               @Nullable java.lang.Object value)
        Sets a value in the YAML and then saves the file
        Parameters:
        path - the path to the node
        value - the value to set the node to
        Returns:
        whether the file was saved successfully
      • save

        public boolean save()
        Saves the YAML to the file
        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 - the Level of the message
        key - the key of the node that the message is about (null if 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 a ConfigurationSection from the path in an Optional
        Parameters:
        path - the path to the node
        Returns:
        the ConfigurationSection or empty if it doesn't exist
      • getSound

        @NotNull
        public @NotNull java.util.Optional<org.bukkit.Sound> getSound​(@NotNull
                                                                      @NotNull java.lang.String path)
        Gets a Sound from the path
        Parameters:
        path - the path to the node
        Returns:
        the Sound or empty if it's invalid
      • getPlayableSound

        @NotNull
        public @NotNull java.util.Optional<PlayableSound> getPlayableSound​(@NotNull
                                                                           @NotNull java.lang.String path)
        Gets a PlayableSound from the path. See the wiki for more information
        Parameters:
        path - the path to the node
        Returns:
        the PlayableSound or empty if it's invalid
      • getPotionEffect

        @NotNull
        public @NotNull java.util.Optional<org.bukkit.potion.PotionEffect> getPotionEffect​(@NotNull
                                                                                           @NotNull java.lang.String path)
        Gets a PotionEffect from the path. See the wiki for more information
        Parameters:
        path - the path to the node
        Returns:
        the PotionEffect or empty if it's invalid
      • getAttributeModifier

        @NotNull
        public <G> @NotNull java.util.Optional<G> getAttributeModifier​(@NotNull
                                                                       @NotNull java.lang.String path)
        1.9+ Gets an AttributeModifier from the path. See the wiki for more information
        Type Parameters:
        G - the AttributeModifier class
        Parameters:
        path - the path to the node
        Returns:
        the AttributeModifier or empty if it's invalid
      • getItemStack

        @Nullable
        public @Nullable org.bukkit.inventory.ItemStack getItemStack​(@NotNull
                                                                     @NotNull java.lang.String path)
        Gets an ItemStack from the path. See the wiki for more information
        Specified by:
        getItemStack in interface org.bukkit.configuration.ConfigurationSection
        Overrides:
        getItemStack in class org.bukkit.configuration.MemorySection
        Parameters:
        path - the path to the node
        Returns:
        the ItemStack or null if 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 an ItemStack from the path. See the wiki for more information
        Specified by:
        getItemStack in interface org.bukkit.configuration.ConfigurationSection
        Overrides:
        getItemStack in class org.bukkit.configuration.MemorySection
        Parameters:
        path - the path to the node
        def - the default value
        Returns:
        the ItemStack or def if it's invalid
      • getItemStackOptional

        @NotNull
        public @NotNull java.util.Optional<org.bukkit.inventory.ItemStack> getItemStackOptional​(@NotNull
                                                                                                @NotNull java.lang.String path)
        Gets an ItemStack from the path. See the wiki for more information
        Parameters:
        path - the path to the node
        Returns:
        the ItemStack or empty if it's invalid
      • getRecipe

        @NotNull
        public @NotNull java.util.Optional<org.bukkit.inventory.Recipe> getRecipe​(@NotNull
                                                                                  @NotNull java.lang.String path)
        Gets a Recipe from the YAML. See the wiki for more information
        Parameters:
        path - the path to get the recipe from
        Returns:
        the Recipe or null if 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 a Recipe from the YAML. See the wiki for more information
        Parameters:
        path - the path to get the recipe from
        itemFunction - the function to apply to the ItemStack before returning it
        Returns:
        the Recipe or 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 a Recipe from the YAML. See the wiki for more information
        Parameters:
        path - the path to get the recipe from
        itemFunction - the function to apply to the ItemStack before returning it
        name - the name of the recipe (only used in 1.12+ for the NamespacedKey), or null to use the node name
        Returns:
        the Recipe or the def if it's invalid