Index
All Classes|All Packages|Constant Field Values
A
- addItem(BaseConfigItem<?>) - Method in class dev.cashire.cashconfig.Config
-
Adds item to root of the config.
- addItem(BaseConfigItem<?>) - Method in class dev.cashire.cashconfig.items.ConfigGroup
-
Adds an item to this Group item.
- addItem(BaseConfigItem<?>) - Method in class dev.cashire.cashconfig.items.ConfigList
-
Adds an item to this Array Item.
- addItem(String, BaseConfigItem<?>) - Method in class dev.cashire.cashconfig.Config
-
Adds item to existing item found at end of path.
- ARRAY - Enum constant in enum class dev.cashire.cashconfig.items.BaseConfigItem.Type
-
Used to represent a json array.
- asBoolean() - Method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Gets this item as a boolean item.
- asGroup() - Method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Gets this item as a group item.
- asList() - Method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Gets this item as a list item.
- asNumber() - Method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Gets this item as a number item.
- asString() - Method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Gets this item as a
ConfigString
item.
B
- BaseConfigItem<T> - Class in dev.cashire.cashconfig.items
-
Base type of all Configuration Items.
- BaseConfigItem(String, BaseConfigItem.Type) - Constructor for class dev.cashire.cashconfig.items.BaseConfigItem
-
BaseConfigItem constructor.
- BaseConfigItem.Type - Enum Class in dev.cashire.cashconfig.items
-
Type representing the value of what is stored in
BaseConfigItem
Is a list of all supported types. - BOOLEAN - Enum constant in enum class dev.cashire.cashconfig.items.BaseConfigItem.Type
-
Used to represent a boolean value.
C
- Config - Class in dev.cashire.cashconfig
-
Configuration Object.
- Config(BaseConfigItem<?>, String) - Constructor for class dev.cashire.cashconfig.Config
-
Create new Configuration Instance.
- Config(File) - Constructor for class dev.cashire.cashconfig.Config
-
Create new Configuration Instance.
- Config(String) - Constructor for class dev.cashire.cashconfig.Config
-
Create new Configuration Instance.
- Config(List<BaseConfigItem<?>>, String) - Constructor for class dev.cashire.cashconfig.Config
-
Create new Configuration Instance.
- Config(BaseConfigItem<?>, File) - Constructor for class dev.cashire.cashconfig.Config
-
Create new Configuration Instance.
- Config(List<BaseConfigItem<?>>, File) - Constructor for class dev.cashire.cashconfig.Config
-
Create new Configuration Instance.
- ConfigBoolean - Class in dev.cashire.cashconfig.items
-
Configuration item for Boolean values for
BaseConfigItem
. - ConfigBoolean() - Constructor for class dev.cashire.cashconfig.items.ConfigBoolean
-
Creates an empty Boolean item with no key If adding to a
ConfigGroup
, useConfigBoolean(String, Boolean)
instead. - ConfigBoolean(String) - Constructor for class dev.cashire.cashconfig.items.ConfigBoolean
-
Creates a new Boolean item with given key.
- ConfigBoolean(String, Boolean) - Constructor for class dev.cashire.cashconfig.items.ConfigBoolean
-
Creates a new Boolean item with given key and value.
- ConfigGroup - Class in dev.cashire.cashconfig.items
-
Configuration item for a json object for
BaseConfigItem
. - ConfigGroup() - Constructor for class dev.cashire.cashconfig.items.ConfigGroup
-
Creates an empty Group item with no key.
- ConfigGroup(String) - Constructor for class dev.cashire.cashconfig.items.ConfigGroup
-
Creates an empty Group item with given key.
- ConfigGroup(String, List<BaseConfigItem<?>>) - Constructor for class dev.cashire.cashconfig.items.ConfigGroup
-
Creates a Group item with given key and items.
- ConfigList - Class in dev.cashire.cashconfig.items
-
Configuration item for a json array for
BaseConfigItem
. - ConfigList() - Constructor for class dev.cashire.cashconfig.items.ConfigList
-
Creates an empty Array item with no key.
- ConfigList(String, List<BaseConfigItem<?>>, BaseConfigItem.Type) - Constructor for class dev.cashire.cashconfig.items.ConfigList
-
Creates an Array item with given key and items null is a valid parameter for items and subType.
- ConfigList(String) - Constructor for class dev.cashire.cashconfig.items.ConfigList
-
Creates an empty Array item with no key.
- ConfigList(String, BaseConfigItem<?>) - Constructor for class dev.cashire.cashconfig.items.ConfigList
-
Creates an Array item with given key and item.
- ConfigNumber - Class in dev.cashire.cashconfig.items
-
Configuration item for Numerical values for
BaseConfigItem
. - ConfigNumber() - Constructor for class dev.cashire.cashconfig.items.ConfigNumber
-
Creates an empty Number item with no key if adding to a
ConfigGroup
, useConfigNumber(String, Number)
instead. - ConfigNumber(String) - Constructor for class dev.cashire.cashconfig.items.ConfigNumber
-
Creates a new Number item with given key.
- ConfigNumber(String, Number) - Constructor for class dev.cashire.cashconfig.items.ConfigNumber
-
Creates a new Number item with given key and value.
- ConfigString - Class in dev.cashire.cashconfig.items
-
Configuration item for String values for
BaseConfigItem
. - ConfigString() - Constructor for class dev.cashire.cashconfig.items.ConfigString
-
Creates an empty String item with no key If adding to a
ConfigGroup
, useConfigString(String, String)
instead. - ConfigString(String) - Constructor for class dev.cashire.cashconfig.items.ConfigString
-
Creates a new String item with given key.
- ConfigString(String, String) - Constructor for class dev.cashire.cashconfig.items.ConfigString
-
Creates a new String item with given key and value.
- Constants - Class in dev.cashire.cashconfig
-
Constants used by this package.
- Constants() - Constructor for class dev.cashire.cashconfig.Constants
D
- dev.cashire.cashconfig - package dev.cashire.cashconfig
- dev.cashire.cashconfig.items - package dev.cashire.cashconfig.items
F
- fromJson(JsonElement) - Method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Deserialize data from the
JsonElement
into this item. - fromJson(JsonElement) - Method in class dev.cashire.cashconfig.items.ConfigBoolean
- fromJson(JsonElement) - Method in class dev.cashire.cashconfig.items.ConfigGroup
- fromJson(JsonElement) - Method in class dev.cashire.cashconfig.items.ConfigList
- fromJson(JsonElement) - Method in class dev.cashire.cashconfig.items.ConfigNumber
- fromJson(JsonElement) - Method in class dev.cashire.cashconfig.items.ConfigString
G
- getInstance(BaseConfigItem.Type) - Static method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Creates a new
BaseConfigItem
instance based on theBaseConfigItem.Type
given. - getInstance(BaseConfigItem.Type, String) - Static method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Creates a new
BaseConfigItem
instance based on theBaseConfigItem.Type
given. - getItem(int) - Method in class dev.cashire.cashconfig.items.ConfigList
-
Returns the item at the given index.
- getItem(String) - Method in class dev.cashire.cashconfig.Config
-
Retrieves an Item from the configuration structure.
- getItem(String) - Method in class dev.cashire.cashconfig.items.ConfigGroup
-
Gets an item with the given key.
- getItem(String, BaseConfigItem.Type) - Method in class dev.cashire.cashconfig.Config
-
Retrieves an Item from the configuration structure.
- getItems() - Method in class dev.cashire.cashconfig.Config
-
Get list of Configuration items in this configuration.
- getKey() - Method in class dev.cashire.cashconfig.items.BaseConfigItem
-
The key this value is stored under in an object.
- getSubType() - Method in class dev.cashire.cashconfig.items.ConfigList
-
Gets the type that the this array item is limited to.
- getType() - Method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Gets the type of this item.
- getType(JsonElement) - Static method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Gets the type associated with a given
JsonElement
. - getType(String) - Method in class dev.cashire.cashconfig.Config
-
Get the type of the item at the given path.
- getValue() - Method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Value stored by this item.
- getValue() - Method in class dev.cashire.cashconfig.items.ConfigGroup
-
The return value is an unmodifiable view of the list
Collections.unmodifiableList(List)
. - getValue() - Method in class dev.cashire.cashconfig.items.ConfigList
-
The return value is an unmodifiable view of the list
Collections.unmodifiableList(List)
. - GROUP - Enum constant in enum class dev.cashire.cashconfig.items.BaseConfigItem.Type
-
Used to represent a json object.
H
- hasFile() - Method in class dev.cashire.cashconfig.Config
-
Checks to see if the file exists.
- hasItem(String) - Method in class dev.cashire.cashconfig.Config
-
Checks if Config has item at given path.
- hasItem(String) - Method in class dev.cashire.cashconfig.items.ConfigGroup
-
Checks to see if an item of a given key exists.
I
- isBoolean() - Method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Checks if this item is a boolean item.
- isGroup() - Method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Checks if this item is a group item.
- isList() - Method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Checks if this item is a list item.
- isList(BaseConfigItem.Type) - Method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Checks if this item is a list item with given subtype.
- isNumber() - Method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Checks if this item is a number item.
- isString() - Method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Checks if this item is a string item.
K
- key - Variable in class dev.cashire.cashconfig.items.BaseConfigItem
-
key for this item.
L
M
N
- NUMBER - Enum constant in enum class dev.cashire.cashconfig.items.BaseConfigItem.Type
-
Used to represent a Numerical value.
R
- readFile() - Method in class dev.cashire.cashconfig.Config
-
Reads configuration from file.
- removeItem(int) - Method in class dev.cashire.cashconfig.items.ConfigList
-
Remove an Item from the list.
- removeItem(String) - Method in class dev.cashire.cashconfig.Config
-
Removes an item from the Config File.
- removeItem(String) - Method in class dev.cashire.cashconfig.items.ConfigGroup
-
Remove an item at a given key.
S
- saveFile() - Method in class dev.cashire.cashconfig.Config
-
Saves current configuration to a file.
- setItem(BaseConfigItem<?>) - Method in class dev.cashire.cashconfig.Config
-
Sets the given item at the root of the config.
- setItem(BaseConfigItem<?>) - Method in class dev.cashire.cashconfig.items.ConfigGroup
-
Sets the item at the given item.
- setItem(String, BaseConfigItem<?>) - Method in class dev.cashire.cashconfig.Config
-
Sets the given item in the existing item at the end of the path.
- setValue(List<BaseConfigItem<?>>) - Method in class dev.cashire.cashconfig.items.ConfigGroup
- setValue(List<BaseConfigItem<?>>) - Method in class dev.cashire.cashconfig.items.ConfigList
- setValue(T) - Method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Set the value of this item.
- size() - Method in class dev.cashire.cashconfig.items.ConfigGroup
-
The amount of items in this Group item.
- size() - Method in class dev.cashire.cashconfig.items.ConfigList
-
The amount of items in this Array Item.
- STRING - Enum constant in enum class dev.cashire.cashconfig.items.BaseConfigItem.Type
-
Used to represent a string value.
T
- toJson(JsonArray) - Method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Serializes data into the given
JsonArray
This item'sBaseConfigItem.getKey()
value is ignored in this case. - toJson(JsonArray) - Method in class dev.cashire.cashconfig.items.ConfigBoolean
- toJson(JsonArray) - Method in class dev.cashire.cashconfig.items.ConfigGroup
- toJson(JsonArray) - Method in class dev.cashire.cashconfig.items.ConfigList
- toJson(JsonArray) - Method in class dev.cashire.cashconfig.items.ConfigNumber
- toJson(JsonArray) - Method in class dev.cashire.cashconfig.items.ConfigString
- toJson(JsonObject) - Method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Serializes data into the given
JsonObject
. - toJson(JsonObject) - Method in class dev.cashire.cashconfig.items.ConfigBoolean
- toJson(JsonObject) - Method in class dev.cashire.cashconfig.items.ConfigGroup
- toJson(JsonObject) - Method in class dev.cashire.cashconfig.items.ConfigList
- toJson(JsonObject) - Method in class dev.cashire.cashconfig.items.ConfigNumber
- toJson(JsonObject) - Method in class dev.cashire.cashconfig.items.ConfigString
- type - Variable in class dev.cashire.cashconfig.items.BaseConfigItem
-
Type of this item.
V
- validType(JsonElement, BaseConfigItem.Type) - Static method in class dev.cashire.cashconfig.items.BaseConfigItem
-
Checks if the given json element matches the given type.
- value - Variable in class dev.cashire.cashconfig.items.BaseConfigItem
-
Value being stored by this item.
- valueOf(String) - Static method in enum class dev.cashire.cashconfig.items.BaseConfigItem.Type
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class dev.cashire.cashconfig.items.BaseConfigItem.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
All Classes|All Packages|Constant Field Values