Constructor Detail

• SettingsAPI

  SettingsAPI(String plugin)

  Creates a SettingsAPI for the specified plugin

Method Detail

• resetSettings

   boolean resetSettings()

  Resets All Settings

  Returns:

  true if successful, else false

• remove

   boolean remove(String key)

  Removes Item from settings

  Parameters:

  key - Key of the value

  Returns:

  True if removed, else false

• getAllKeys

   List<String> getAllKeys()

  Gets All Keys from settings

  Returns:

  List of all keys

• 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

  Returns:

  Toggled boolean

• exists

   boolean exists(String key)

  Check if Key exists in settings

  Parameters:

  key - Key of the value

  Returns:

  True if found, else false

• getBool

   boolean getBool(String key, boolean defValue)

  Reads a from the settings.

  Parameters:

  key - Key of the setting.

  defValue - Default value of the setting.

  Returns:

  Stored value, or default value if it doesn't exist.

• 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.

  Returns:

  Stored value, or default value if it doesn't exist.

• 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.

  Returns:

  Stored value, or default value if it doesn't exist.

• 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.

  Returns:

  Stored value, or default value if it doesn't exist.

• 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.

  Returns:

  Stored value, or default value if it doesn't exist.

• 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.

  Returns:

  Stored value, or default value if it doesn't exist.

• 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.

  Returns:

  Stored value, or default value if it doesn't exist.

• setObject

   void setObject(String key, Object val)

  Writes an Object to the settings.

  Parameters:

  key - Key of the setting.

  val - Value of the setting.

• getUnknown

   Object getUnknown(String key, Object defValue)

  Get a value of an unknown type

  Parameters:

  key - Key of the item

• 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