Package dev.cashire.cashconfig.items

Class ConfigString

java.lang.Object

dev.cashire.cashconfig.items.BaseConfigItem<String>

dev.cashire.cashconfig.items.ConfigString

public final class ConfigString
extends BaseConfigItem<String>

Configuration item for String values for BaseConfigItem.

Nested Class Summary

Nested classes/interfaces inherited from class dev.cashire.cashconfig.items.BaseConfigItem

BaseConfigItem.Type

Field Summary

Fields inherited from class dev.cashire.cashconfig.items.BaseConfigItem

key, type, value

Constructor Summary

Constructors

Constructor	Description
ConfigString()	Creates an empty String item with no key If adding to a ConfigGroup, use ConfigString(String, String) instead.
ConfigString(@NotNull String key)	Creates a new String item with given key.
ConfigString(@NotNull String key, String str)	Creates a new String item with given key and value.

Method Summary

Modifier and Type	Method	Description
void	fromJson(@NotNull com.google.gson.JsonElement element)	Deserialize data from the JsonElement into this item.
void	toJson(@NotNull com.google.gson.JsonArray parent)	Serializes data into the given JsonArray This item's BaseConfigItem.getKey() value is ignored in this case.
void	toJson(@NotNull com.google.gson.JsonObject parent)	Serializes data into the given JsonObject.

Methods inherited from class dev.cashire.cashconfig.items.BaseConfigItem

asBoolean, asGroup, asList, asNumber, asString, getInstance, getInstance, getKey, getType, getType, getValue, isBoolean, isGroup, isList, isList, isNumber, isString, setValue, validType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ConfigString

public ConfigString()

Creates an empty String item with no key If adding to a ConfigGroup, use ConfigString(String, String) instead.

ConfigString

public ConfigString(@NotNull
 @NotNull String key)

Creates a new String item with given key.

Parameters:

key - The key to be used if put in a group.

ConfigString

public ConfigString(@NotNull
 @NotNull String key,
 String str)

Creates a new String item with given key and value.

Parameters:

key - The key to be used if put in a group.

str - The default value contained in this item.

Method Details

toJson

public void toJson(@NotNull
 @NotNull com.google.gson.JsonObject parent)

Description copied from class: BaseConfigItem

Serializes data into the given JsonObject. This item is put in the JsonObject at key value given by BaseConfigItem.getKey(). It is put in as type given by BaseConfigItem.getType()

Specified by:

toJson in class BaseConfigItem<String>

Parameters:

parent - JsonObject to add this item to.

toJson

public void toJson(@NotNull
 @NotNull com.google.gson.JsonArray parent)

Description copied from class: BaseConfigItem

Serializes data into the given JsonArray This item's BaseConfigItem.getKey() value is ignored in this case. It is put in as type given by BaseConfigItem.getType()

Specified by:

toJson in class BaseConfigItem<String>

Parameters:

parent - JsonArray to add to this item to.

fromJson

public void fromJson(@NotNull
 @NotNull com.google.gson.JsonElement element)

Description copied from class: BaseConfigItem

Deserialize data from the JsonElement into this item. Treats the JsonElement as the type given by BaseConfigItem.getType()

Specified by:

fromJson in class BaseConfigItem<String>

Parameters:

element - JsonElement to load data from.