Package com.kamikazejam.kamicommon.configuration.spigot

Class KamiConfig

java.lang.Object

com.kamikazejam.kamicommon.configuration.standalone.AbstractConfig<YamlConfiguration>

com.kamikazejam.kamicommon.configuration.spigot.KamiConfig

All Implemented Interfaces:

ObservableConfig, ConfigurationMethods<ConfigurationSection>, ConfigurationSection

Direct Known Subclasses:

KamiConfigExt

public class KamiConfig
extends AbstractConfig<YamlConfiguration>
implements ConfigurationSection, ObservableConfig

A class that represents a configuration file (Meant for implementations WITH a JavaPlugin object available)
If you DO NOT have a JavaPlugin object, it is recommended to use StandaloneConfig instead
This is an extension of a YamlConfiguration, so all get, set, and put methods are available.

When extending this class, provide the File to the config in the super, and then add all desired comments
Then you can use this object just like a YamlConfiguration, it has all the same methods plus a few others like reload()

Constructor Summary

Constructors

Constructor	Description
KamiConfig(@NotNull AbstractSubsystem<?,?> subsystem, @NotNull ConfigSource source)	Creates a new config instance with the given subsystem and config source. This constructor enables defaults using the following resource file method: - Fetches the resource file using the provided source, from AbstractSubsystem.getSupplementalConfigResource(ConfigSource)
KamiConfig(@NotNull AbstractSubsystem<?,?> subsystem, @NotNull ConfigSource source, @Nullable Supplier<InputStream> defaultsStream)	Creates a new config instance with the given subsystem and config source. This constructor uses defaults if and only if the provided supplier is NOT null: - Providing a non-null supplier will enable defaults using the provided InputStream - Providing a null supplier will disable defaults
KamiConfig(@NotNull AbstractSubsystem<?,?> subsystem, @NotNull File file)	Creates a new config instance with the given subsystem and destination file. This constructor enables defaults using the following resource file method: - Fetches the resource file using the provided file name, from AbstractSubsystem.getSupplementalConfigResource(File)
KamiConfig(@NotNull AbstractSubsystem<?,?> subsystem, @NotNull File file, @Nullable Supplier<InputStream> defaultsStream)	Creates a new config instance with the given subsystem and destination file. This constructor uses defaults if and only if the provided supplier is NOT null: - Providing a non-null supplier will enable defaults using the provided InputStream - Providing a null supplier will disable defaults
KamiConfig(@NotNull JavaPlugin plugin, @NotNull ConfigSource source)	Creates a new config instance with the given plugin and config source. This constructor enables defaults using the following resource file method: - Fetches the resource file.
KamiConfig(@NotNull JavaPlugin plugin, @NotNull ConfigSource source, @Nullable Supplier<InputStream> defaultsStream)	Creates a new config instance with the given plugin and config source. This constructor uses defaults if and only if the provided supplier is NOT null: - Providing a non-null supplier will enable defaults using the provided InputStream - Providing a null supplier will disable defaults
KamiConfig(@NotNull JavaPlugin plugin, @NotNull File file)	Creates a new config instance with the given plugin and destination file. This constructor enables defaults using the following resource file method: - Assumes a resource file with the same name as the provided file, exists in the current jar.
KamiConfig(@NotNull JavaPlugin plugin, @NotNull File file, @Nullable Supplier<InputStream> defaultsStream)	Creates a new config instance with the given plugin and destination file. This constructor uses defaults if and only if the provided supplier is NOT null: - Providing a non-null supplier will enable defaults using the provided InputStream - Providing a null supplier will disable defaults

Method Summary

Modifier and Type	Method	Description
void	addDefault(String key, Object o)
boolean	contains(String key)
Object	get(String key)
Object	get(String key, Object def)
BigDecimal	getBigDecimal(String key)
BigDecimal	getBigDecimal(String key, BigDecimal def)
boolean	getBoolean(String key)
boolean	getBoolean(String key, boolean def)
byte	getByte(String key)
byte	getByte(String key, byte def)
List<Byte>	getByteList(String key)
List<Byte>	getByteList(String key, List<Byte> def)
@NotNull MemorySection	getConfigurationSection(String key)
@NotNull ConfigurationSequenceSpigot	getConfigurationSequence(String key)
String	getCurrentPath()
double	getDouble(String key)
double	getDouble(String key, double def)
float	getFloat(String key)
float	getFloat(String key, float def)
int	getInt(String key)
int	getInt(String key, int def)
List<Integer>	getIntegerList(String key)
List<Integer>	getIntegerList(String key, List<Integer> def)
ItemStack	getItemStack(String key)
ItemStack	getItemStack(String key, ItemStack def)
Set<String>	getKeys(boolean deep)	Returns the keys of the config If Deep is enabled, it will dig and find all valid keys that resolve to a value
List<?>	getList(String key)
List<?>	getList(String path, List<?> def)
long	getLong(String key)
long	getLong(String key, long def)
short	getShort(String key)
short	getShort(String key, short def)
@NotNull ConfigSource	getSource()
String	getString(String key)
String	getString(String key, String def)
List<String>	getStringList(String key)
List<String>	getStringList(String key, List<String> def)
protected YamlConfiguration	getYamlConfiguration()
boolean	isBoolean(String key)
boolean	isByte(String key)
boolean	isConfigurationSection(String key)
boolean	isDouble(String key)
boolean	isEmpty()
boolean	isFloat(String key)
boolean	isInt(String key)
boolean	isItemStack(String key)
boolean	isList(String key)
boolean	isLong(String key)
boolean	isNumber(String key)
boolean	isSet(String key)
boolean	isShort(String key)
boolean	isString(String key)
@NotNull ItemBuilder	parseItemBuilder(@NotNull String key)	Parses the subsection at the given key into an ItemBuilder.
void	put(String key, Object value)
void	putBoolean(String key, boolean value)
void	putByte(String key, byte value)
void	putDouble(String key, double value)
void	putFloat(String key, float value)
void	putInt(String key, int value)
void	putInteger(String key, int value)
void	putLong(String key, long value)
void	putShort(String key, short value)
void	putString(String key, String value)
boolean	registerConfigObserver(@NotNull ConfigObserver observer)	Registers an observer to this config (if not already registered) Refer to the ConfigObserver docs for information on its lifecycle.
void	reload()	Reloads the config from the file
void	reloadObservableConfig()	Reload the backing config for this observable, notifying all registered observers of the change. Equivalent to calling reload()
void	set(String key, Object value)
void	setBoolean(String key, boolean value)
void	setByte(String key, byte value)
void	setDouble(String key, double value)
void	setFloat(String key, float value)
void	setInt(String key, int value)
void	setInteger(String key, int value)
void	setItemStack(String key, ItemStack item)
void	setLong(String key, long value)
void	setShort(String key, short value)
void	setString(String key, String value)
void	unregisterConfigObserver(@NotNull ConfigObserver observer)	Unregisters an observer from this config
void	unregisterConfigObservers()	Unregisters ALL observers from this config. Intended for shutdown logic, but can be used at any time.

Methods inherited from class com.kamikazejam.kamicommon.configuration.standalone.AbstractConfig

isChanged, save, save, setChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kamikazejam.kamicommon.yaml.base.ConfigurationMethods

isChanged, setChanged

Constructor Details

KamiConfig

public KamiConfig(@NotNull
 @NotNull JavaPlugin plugin,
 @NotNull
 @NotNull File file)

Creates a new config instance with the given plugin and destination file.

This constructor enables defaults using the following resource file method:
- Assumes a resource file with the same name as the provided file, exists in the current jar.

KamiConfig

public KamiConfig(@NotNull
 @NotNull JavaPlugin plugin,
 @NotNull
 @NotNull File file,
 @Nullable
 @Nullable Supplier<InputStream> defaultsStream)

Creates a new config instance with the given plugin and destination file.

This constructor uses defaults if and only if the provided supplier is NOT null:
- Providing a non-null supplier will enable defaults using the provided InputStream - Providing a null supplier will disable defaults

Parameters:

defaultsStream - The optional supplier to load defaults from.

KamiConfig

public KamiConfig(@NotNull
 @NotNull JavaPlugin plugin,
 @NotNull
 @NotNull ConfigSource source)

Creates a new config instance with the given plugin and config source.

This constructor enables defaults using the following resource file method:
- Fetches the resource file. Its path is determined by ConfigSource.getResourceStreamPath()

Parameters:

source - The source to load and save the config from.

KamiConfig

public KamiConfig(@NotNull
 @NotNull JavaPlugin plugin,
 @NotNull
 @NotNull ConfigSource source,
 @Nullable
 @Nullable Supplier<InputStream> defaultsStream)

Creates a new config instance with the given plugin and config source.

This constructor uses defaults if and only if the provided supplier is NOT null:
- Providing a non-null supplier will enable defaults using the provided InputStream - Providing a null supplier will disable defaults

Parameters:

source - The source to load and save the config from.

defaultsStream - The optional supplier to load defaults from.

KamiConfig

public KamiConfig(@NotNull
 @NotNull AbstractSubsystem<?,?> subsystem,
 @NotNull
 @NotNull File file)

Creates a new config instance with the given subsystem and destination file.

This constructor enables defaults using the following resource file method:
- Fetches the resource file using the provided file name, from AbstractSubsystem.getSupplementalConfigResource(File)

KamiConfig

public KamiConfig(@NotNull
 @NotNull AbstractSubsystem<?,?> subsystem,
 @NotNull
 @NotNull File file,
 @Nullable
 @Nullable Supplier<InputStream> defaultsStream)

Creates a new config instance with the given subsystem and destination file.

This constructor uses defaults if and only if the provided supplier is NOT null:
- Providing a non-null supplier will enable defaults using the provided InputStream - Providing a null supplier will disable defaults

KamiConfig

public KamiConfig(@NotNull
 @NotNull AbstractSubsystem<?,?> subsystem,
 @NotNull
 @NotNull ConfigSource source)

Creates a new config instance with the given subsystem and config source.

This constructor enables defaults using the following resource file method:
- Fetches the resource file using the provided source, from AbstractSubsystem.getSupplementalConfigResource(ConfigSource)

Parameters:

source - The source to load and save the config from.

KamiConfig

public KamiConfig(@NotNull
 @NotNull AbstractSubsystem<?,?> subsystem,
 @NotNull
 @NotNull ConfigSource source,
 @Nullable
 @Nullable Supplier<InputStream> defaultsStream)

Creates a new config instance with the given subsystem and config source.

This constructor uses defaults if and only if the provided supplier is NOT null:
- Providing a non-null supplier will enable defaults using the provided InputStream - Providing a null supplier will disable defaults

Parameters:

source - The source to load and save the config from.

defaultsStream - The optional supplier to load defaults from.

Method Details

reload

public void reload()

Description copied from class: AbstractConfig

Reloads the config from the file

Specified by:

reload in class AbstractConfig<YamlConfiguration>

getSource

@NotNull
public @NotNull ConfigSource getSource()

Specified by:

getSource in class AbstractConfig<YamlConfiguration>

Returns:

The file associated with this config

getYamlConfiguration

protected YamlConfiguration getYamlConfiguration()

Specified by:

getYamlConfiguration in class AbstractConfig<YamlConfiguration>

Returns:

The YamlConfiguration associated with this config

registerConfigObserver

public boolean registerConfigObserver(@NotNull
 @NotNull ConfigObserver observer)

Description copied from interface: ObservableConfig

Registers an observer to this config (if not already registered)
Refer to the ConfigObserver docs for information on its lifecycle.

Specified by:

registerConfigObserver in interface ObservableConfig

Returns:

If the observer was successfully registered from this call (false if already registered)

unregisterConfigObserver

public void unregisterConfigObserver(@NotNull
 @NotNull ConfigObserver observer)

Description copied from interface: ObservableConfig

Unregisters an observer from this config

Specified by:

unregisterConfigObserver in interface ObservableConfig

unregisterConfigObservers

public void unregisterConfigObservers()

Description copied from interface: ObservableConfig

Unregisters ALL observers from this config.
Intended for shutdown logic, but can be used at any time.

Specified by:

unregisterConfigObservers in interface ObservableConfig

reloadObservableConfig

public void reloadObservableConfig()

Reload the backing config for this observable, notifying all registered observers of the change.

Equivalent to calling reload()

Specified by:

reloadObservableConfig in interface ObservableConfig

set

public void set(String key,
 Object value)

Specified by:

set in interface ConfigurationMethods<ConfigurationSection>

put

public void put(String key,
 Object value)

Specified by:

put in interface ConfigurationMethods<ConfigurationSection>

putString

public void putString(String key,
 String value)

Specified by:

putString in interface ConfigurationMethods<ConfigurationSection>

putBoolean

public void putBoolean(String key,
 boolean value)

Specified by:

putBoolean in interface ConfigurationMethods<ConfigurationSection>

putByte

public void putByte(String key,
 byte value)

Specified by:

putByte in interface ConfigurationMethods<ConfigurationSection>

putShort

public void putShort(String key,
 short value)

Specified by:

putShort in interface ConfigurationMethods<ConfigurationSection>

putInteger

public void putInteger(String key,
 int value)

Specified by:

putInteger in interface ConfigurationMethods<ConfigurationSection>

putInt

public void putInt(String key,
 int value)

Specified by:

putInt in interface ConfigurationMethods<ConfigurationSection>

putLong

public void putLong(String key,
 long value)

Specified by:

putLong in interface ConfigurationMethods<ConfigurationSection>

putDouble

public void putDouble(String key,
 double value)

Specified by:

putDouble in interface ConfigurationMethods<ConfigurationSection>

putFloat

public void putFloat(String key,
 float value)

Specified by:

putFloat in interface ConfigurationMethods<ConfigurationSection>

setString

public void setString(String key,
 String value)

Specified by:

setString in interface ConfigurationMethods<ConfigurationSection>

setBoolean

public void setBoolean(String key,
 boolean value)

Specified by:

setBoolean in interface ConfigurationMethods<ConfigurationSection>

setByte

public void setByte(String key,
 byte value)

Specified by:

setByte in interface ConfigurationMethods<ConfigurationSection>

setShort

public void setShort(String key,
 short value)

Specified by:

setShort in interface ConfigurationMethods<ConfigurationSection>

setInteger

public void setInteger(String key,
 int value)

Specified by:

setInteger in interface ConfigurationMethods<ConfigurationSection>

setInt

public void setInt(String key,
 int value)

Specified by:

setInt in interface ConfigurationMethods<ConfigurationSection>

setLong

public void setLong(String key,
 long value)

Specified by:

setLong in interface ConfigurationMethods<ConfigurationSection>

setDouble

public void setDouble(String key,
 double value)

Specified by:

setDouble in interface ConfigurationMethods<ConfigurationSection>

setFloat

public void setFloat(String key,
 float value)

Specified by:

setFloat in interface ConfigurationMethods<ConfigurationSection>

get

public Object get(String key)

Specified by:

get in interface ConfigurationMethods<ConfigurationSection>

get

public Object get(String key,
 Object def)

Specified by:

get in interface ConfigurationMethods<ConfigurationSection>

getConfigurationSection

@NotNull
public @NotNull MemorySection getConfigurationSection(String key)

Specified by:

getConfigurationSection in interface ConfigurationMethods<ConfigurationSection>

getConfigurationSequence

@NotNull
public @NotNull ConfigurationSequenceSpigot getConfigurationSequence(String key)

Specified by:

getConfigurationSequence in interface ConfigurationMethods<ConfigurationSection>

getString

public String getString(String key)

Specified by:

getString in interface ConfigurationMethods<ConfigurationSection>

getString

public String getString(String key,
 String def)

Specified by:

getString in interface ConfigurationMethods<ConfigurationSection>

isString

public boolean isString(String key)

Specified by:

isString in interface ConfigurationMethods<ConfigurationSection>

getInt

public int getInt(String key)

Specified by:

getInt in interface ConfigurationMethods<ConfigurationSection>

getInt

public int getInt(String key,
 int def)

Specified by:

getInt in interface ConfigurationMethods<ConfigurationSection>

isInt

public boolean isInt(String key)

Specified by:

isInt in interface ConfigurationMethods<ConfigurationSection>

getLong

public long getLong(String key)

Specified by:

getLong in interface ConfigurationMethods<ConfigurationSection>

getLong

public long getLong(String key,
 long def)

Specified by:

getLong in interface ConfigurationMethods<ConfigurationSection>

isLong

public boolean isLong(String key)

Specified by:

isLong in interface ConfigurationMethods<ConfigurationSection>

getList

public List<?> getList(String key)

Specified by:

getList in interface ConfigurationMethods<ConfigurationSection>

getList

public List<?> getList(String path,
 List<?> def)

Specified by:

getList in interface ConfigurationMethods<ConfigurationSection>

isList

public boolean isList(String key)

Specified by:

isList in interface ConfigurationMethods<ConfigurationSection>

getBoolean

public boolean getBoolean(String key)

Specified by:

getBoolean in interface ConfigurationMethods<ConfigurationSection>

getBoolean

public boolean getBoolean(String key,
 boolean def)

Specified by:

getBoolean in interface ConfigurationMethods<ConfigurationSection>

isBoolean

public boolean isBoolean(String key)

Specified by:

isBoolean in interface ConfigurationMethods<ConfigurationSection>

getStringList

public List<String> getStringList(String key)

Specified by:

getStringList in interface ConfigurationMethods<ConfigurationSection>

getStringList

public List<String> getStringList(String key,
 List<String> def)

Specified by:

getStringList in interface ConfigurationMethods<ConfigurationSection>

getIntegerList

public List<Integer> getIntegerList(String key)

Specified by:

getIntegerList in interface ConfigurationMethods<ConfigurationSection>

getIntegerList

public List<Integer> getIntegerList(String key,
 List<Integer> def)

Specified by:

getIntegerList in interface ConfigurationMethods<ConfigurationSection>

getByteList

public List<Byte> getByteList(String key)

Specified by:

getByteList in interface ConfigurationMethods<ConfigurationSection>

getByteList

public List<Byte> getByteList(String key,
 List<Byte> def)

Specified by:

getByteList in interface ConfigurationMethods<ConfigurationSection>

getDouble

public double getDouble(String key)

Specified by:

getDouble in interface ConfigurationMethods<ConfigurationSection>

getDouble

public double getDouble(String key,
 double def)

Specified by:

getDouble in interface ConfigurationMethods<ConfigurationSection>

isDouble

public boolean isDouble(String key)

Specified by:

isDouble in interface ConfigurationMethods<ConfigurationSection>

getByte

public byte getByte(String key)

Specified by:

getByte in interface ConfigurationMethods<ConfigurationSection>

getByte

public byte getByte(String key,
 byte def)

Specified by:

getByte in interface ConfigurationMethods<ConfigurationSection>

isByte

public boolean isByte(String key)

Specified by:

isByte in interface ConfigurationMethods<ConfigurationSection>

getShort

public short getShort(String key)

Specified by:

getShort in interface ConfigurationMethods<ConfigurationSection>

getShort

public short getShort(String key,
 short def)

Specified by:

getShort in interface ConfigurationMethods<ConfigurationSection>

isShort

public boolean isShort(String key)

Specified by:

isShort in interface ConfigurationMethods<ConfigurationSection>

getFloat

public float getFloat(String key)

Specified by:

getFloat in interface ConfigurationMethods<ConfigurationSection>

getFloat

public float getFloat(String key,
 float def)

Specified by:

getFloat in interface ConfigurationMethods<ConfigurationSection>

isFloat

public boolean isFloat(String key)

Specified by:

isFloat in interface ConfigurationMethods<ConfigurationSection>

getBigDecimal

public BigDecimal getBigDecimal(String key)

Specified by:

getBigDecimal in interface ConfigurationMethods<ConfigurationSection>

getBigDecimal

public BigDecimal getBigDecimal(String key,
 BigDecimal def)

Specified by:

getBigDecimal in interface ConfigurationMethods<ConfigurationSection>

isNumber

public boolean isNumber(String key)

Specified by:

isNumber in interface ConfigurationMethods<ConfigurationSection>

getKeys

public Set<String> getKeys(boolean deep)

Returns the keys of the config If Deep is enabled, it will dig and find all valid keys that resolve to a value

Specified by:

getKeys in interface ConfigurationMethods<ConfigurationSection>

Parameters:

deep - Whether to search for all sub-keys

Returns:

The list of keys found

isConfigurationSection

public boolean isConfigurationSection(String key)

Specified by:

isConfigurationSection in interface ConfigurationMethods<ConfigurationSection>

contains

public boolean contains(String key)

Specified by:

contains in interface ConfigurationMethods<ConfigurationSection>

isSet

public boolean isSet(String key)

Specified by:

isSet in interface ConfigurationMethods<ConfigurationSection>

addDefault

public void addDefault(String key,
 Object o)

Specified by:

addDefault in interface ConfigurationMethods<ConfigurationSection>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface ConfigurationMethods<ConfigurationSection>

getItemStack

public ItemStack getItemStack(String key)

Specified by:

getItemStack in interface ConfigurationSection

getItemStack

public ItemStack getItemStack(String key,
 ItemStack def)

Specified by:

getItemStack in interface ConfigurationSection

setItemStack

public void setItemStack(String key,
 ItemStack item)

Specified by:

setItemStack in interface ConfigurationSection

isItemStack

public boolean isItemStack(String key)

Specified by:

isItemStack in interface ConfigurationSection

parseItemBuilder

@NotNull
public @NotNull ItemBuilder parseItemBuilder(@NotNull
 @NotNull String key)

Description copied from interface: ConfigurationSection

Parses the subsection at the given key into an ItemBuilder. This is equivalent to using:
- ItemBuilderLoader.load(ConfigurationSection) with the subsection at the given key as the argument.

Specified by:

parseItemBuilder in interface ConfigurationSection

Parameters:

key - The key of the subsection to parse.

Returns:

The parsed ItemBuilder.

getCurrentPath

public String getCurrentPath()

Specified by:

getCurrentPath in interface ConfigurationMethods<ConfigurationSection>

Specified by:

getCurrentPath in interface ConfigurationSection