Class JsonConfig

java.lang.Object

com.thecsdev.common.config.JsonConfig

Direct Known Subclasses:

ModConfig

public abstract class JsonConfig
extends Object

A container for various configurable properties that can be saved and to and loaded from the user's disk drive.

This configuration system uses reflection to save and load properties found within a given container.

The data is saved and loaded in JSON format.

See Also:

• Expose
• SerializedName

API Note:

Depends on Guava - com.google.*.

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable File	configFile	The main File where this JsonConfig is to be stored at.
static final com.google.gson.Gson	GSON	The main Gson instance used by JsonConfig, for serialization and deserialization of config properties.

Constructor Summary

Constructors

Constructor	Description
JsonConfig()
JsonConfig(@Nullable File configFile)

Method Summary

Modifier and Type	Method	Description
protected @Nullable File	getConfigFile()	Returns the File that is used by saveToFile() and loadFromFile() when saving and loading this JsonConfig.
static final Stream<Field>	getDeserializableProperties(@NotNull Class<? extends JsonConfig> clazz)	From getProperties(Class), filters out only deserializable properties.
static final Stream<Field>	getProperties(@NotNull Class<? extends JsonConfig> clazz)	Returns a Stream of all Fields (including inherited) that should be handled during serialization and deserialization of the given JsonConfig Class.
static String[]	getPropertyNames(@NotNull Field property)	Resolves the serialized names for a Field using its SerializedName annotation (if present), returning the primary name followed by any alternates.
static final Stream<Field>	getSerializableProperties(@NotNull Class<? extends JsonConfig> clazz)	From getProperties(Class), filters out only serializable properties.
final void	loadFromFile()	Loads this JsonConfig from the getConfigFile(). If the File does not exist, nothing happens.
final void	loadFromJson(@NotNull com.google.gson.JsonObject from)	Loads this JsonConfig from a JsonObject, overriding any properties of this JsonConfig that were stored in the JsonObject.
protected void	onLoad(@NotNull com.google.gson.JsonObject from)	Called after loadFromJson(JsonObject) finishes its execution.
protected void	onSave(@NotNull com.google.gson.JsonObject to)	Called after saveToJson(JsonObject) finishes its execution.
final void	saveToFile()	Saves this JsonConfig to the getConfigFile(). Overrides any existing getConfigFile()s.
final @NotNull com.google.gson.JsonObject	saveToJson()	Saves this JsonConfig instance to a new JsonObject instance and returns the JsonObject.
final void	saveToJson(@NotNull com.google.gson.JsonObject to)	Saves this JsonConfig to an existing JsonObject instance.
protected void	setConfigFile(@Nullable File file)	Sets the File that is used by saveToFile() and loadFromFile() when saving and loading this JsonConfig.

Methods inherited from class Object

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

Field Details

GSON

@Internal
public static final com.google.gson.Gson GSON

The main Gson instance used by JsonConfig, for serialization and deserialization of config properties.

configFile

@Nullable
protected transient volatile @Nullable File configFile

The main File where this JsonConfig is to be stored at.

Constructor Details

JsonConfig

public JsonConfig()

JsonConfig

public JsonConfig(@Nullable
 @Nullable File configFile)

Method Details

getConfigFile

@Virtual
@Nullable
protected @Nullable File getConfigFile()

Returns the File that is used by saveToFile() and loadFromFile() when saving and loading this JsonConfig.

See Also:

• saveToFile()
• loadFromFile()
• setConfigFile(File)

setConfigFile

@Virtual
protected void setConfigFile(@Nullable
 @Nullable File file)

Sets the File that is used by saveToFile() and loadFromFile() when saving and loading this JsonConfig.

Parameters:

file - The new File value.

See Also:

• saveToFile()
• loadFromFile()
• getConfigFile()

onSave

@Virtual
protected void onSave(@NotNull
 @NotNull com.google.gson.JsonObject to)

Called after saveToJson(JsonObject) finishes its execution.

Parameters:

to - The JsonObject the data was saved to.

onLoad

@Virtual
protected void onLoad(@NotNull
 @NotNull com.google.gson.JsonObject from)

Called after loadFromJson(JsonObject) finishes its execution.

Parameters:

from - The JsonObject the data was loaded from.

saveToJson

@NotNull
public final @NotNull com.google.gson.JsonObject saveToJson()

Saves this JsonConfig instance to a new JsonObject instance and returns the JsonObject.

saveToJson

public final void saveToJson(@NotNull
 @NotNull com.google.gson.JsonObject to)
                      throws NullPointerException

Saves this JsonConfig to an existing JsonObject instance.

Parameters:

to - The JsonObject to save to.

Throws:

NullPointerException - If the argument is null.

loadFromJson

public final void loadFromJson(@NotNull
 @NotNull com.google.gson.JsonObject from)
                        throws NullPointerException

Loads this JsonConfig from a JsonObject, overriding any properties of this JsonConfig that were stored in the JsonObject. Mismatched types and null values do not override existing values.

Parameters:

from - The JsonObject to load from.

Throws:

NullPointerException - If the argument is null.

saveToFile

public final void saveToFile()
                      throws NullPointerException,
IOException

Saves this JsonConfig to the getConfigFile().
Overrides any existing getConfigFile()s.

Throws:

NullPointerException - If getConfigFile() is null.

IOException - If an IOException takes place.

loadFromFile

public final void loadFromFile()
                        throws NullPointerException,
IOException

Loads this JsonConfig from the getConfigFile().
If the File does not exist, nothing happens.

Throws:

NullPointerException - If getConfigFile() is null.

IOException - If an IOException takes place.

getProperties

public static final Stream<Field> getProperties(@NotNull
 @NotNull Class<? extends JsonConfig> clazz)
                                         throws NullPointerException

Returns a Stream of all Fields (including inherited) that should be handled during serialization and deserialization of the given JsonConfig Class.

Fields are included only if they meet all the following conditions:

• Are not static
• Are not transient
• Are not arrays
• Are primitive types or Serializable or JsonConfig
• Are annotated with Expose

Parameters:

clazz - the JsonConfig class to inspect.

Returns:

a Stream of eligible Fields.

Throws:

NullPointerException - If the argument is null.

getSerializableProperties

public static final Stream<Field> getSerializableProperties(@NotNull
 @NotNull Class<? extends JsonConfig> clazz)
                                                     throws NullPointerException

From getProperties(Class), filters out only serializable properties.

Parameters:

clazz - the JsonConfig class to inspect.

Throws:

NullPointerException - If the argument is null.

getDeserializableProperties

public static final Stream<Field> getDeserializableProperties(@NotNull
 @NotNull Class<? extends JsonConfig> clazz)
                                                       throws NullPointerException

From getProperties(Class), filters out only deserializable properties.

Parameters:

clazz - The JsonConfig class to inspect.

Throws:

NullPointerException - If the argument is null.

getPropertyNames

public static String[] getPropertyNames(@NotNull
 @NotNull Field property)
                                 throws NullPointerException

Resolves the serialized names for a Field using its SerializedName annotation (if present), returning the primary name followed by any alternates.

Parameters:

property - The Field to inspect.

Returns:

An array of names to use for serialization/deserialization (never null, non-empty).

Throws:

NullPointerException - If the argument is null.