Class SettingsAPI

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
      SettingsAPI(String plugin) Creates a SettingsAPI for the specified plugin
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Constructor Detail

      • SettingsAPI

        SettingsAPI(String plugin)
        Creates a SettingsAPI for the specified plugin
    • Method Detail

      • remove

         boolean remove(String key)

        Removes Item from settings

        Parameters:
        key - Key of the value
      • toggleBool

         boolean toggleBool(String key, boolean defValue)

        Toggles Boolean and returns it

        Parameters:
        key - Key of the value
        defValue - Default Value if setting doesn't exist
      • exists

         boolean exists(String key)

        Check if Key exists in settings

        Parameters:
        key - Key of the value
      • getBool

         boolean getBool(String key, boolean defValue)

        Reads a from the settings.

        Parameters:
        key - Key of the setting.
        defValue - Default value of the setting.
      • setBool

         void setBool(String key, boolean val)

        Writes a to the settings.

        Parameters:
        key - Key of the setting.
        val - Value of the setting.
      • getInt

         int getInt(String key, int defValue)

        Gets an stored in the settings.

        Parameters:
        key - Key of the setting.
        defValue - Default value of the setting.
      • setInt

         void setInt(String key, int val)

        Writes an to the settings.

        Parameters:
        key - Key of the setting.
        val - Value of the setting.
      • getFloat

         float getFloat(String key, float defValue)

        Gets a stored in the settings.

        Parameters:
        key - Key of the setting.
        defValue - Default value of the setting.
      • setFloat

         void setFloat(String key, float val)

        Writes a to the settings.

        Parameters:
        key - Key of the setting.
        val - Value of the setting.
      • getLong

         long getLong(String key, long defValue)

        Gets a stored in the settings.

        Parameters:
        key - Key of the setting.
        defValue - Default value of the setting.
      • setLong

         void setLong(String key, long val)

        Writes a to the settings.

        Parameters:
        key - Key of the setting.
        val - Value of the setting.
      • getString

         String getString(String key, String defValue)

        Gets a String stored in the settings.

        Parameters:
        key - Key of the setting.
        defValue - Default value of the setting.
      • setString

         void setString(String key, String val)

        Writes a String to the settings.

        Parameters:
        key - Key of the setting.
        val - Value of the setting.
      • getObject

         <T> T getObject(String key, T defValue)

        Gets an Object stored in the settings.

        Parameters:
        key - Key of the setting.
        defValue - Default value of the setting.
      • getObject

         <T> T getObject(String key, T defValue, Type type)

        Gets an Object stored in the settings.

        Parameters:
        key - Key of the setting.
        defValue - Default value of the setting.
        type - Object representing the data type.
      • setObject

         void setObject(String key, Object val)

        Writes an Object to the settings.

        Parameters:
        key - Key of the setting.
        val - Value of the setting.
      • setUnknown

         void setUnknown(String key, Object value)

        Set a value of an unknown type

        Parameters:
        key - Key of the item
        value - Value of the item