Class SubsystemConfig<S extends AbstractSubsystem<?,S>>

java.lang.Object

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

com.kamikazejam.kamicommon.configuration.spigot.KamiConfig

com.kamikazejam.kamicommon.configuration.spigot.KamiConfigExt

com.kamikazejam.kamicommon.subsystem.SubsystemConfig<S>

All Implemented Interfaces:

ObservableConfig<KamiConfig>, ConfigurationMethods<ConfigurationSection>, ConfigurationSection

Direct Known Subclasses:

FeatureConfig, ModuleConfig

public abstract class SubsystemConfig<S extends AbstractSubsystem<?,S>>
extends KamiConfigExt

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SubsystemConfig(S subsystem, @NotNull ConfigSource source, @NotNull String resourcePath)	Constructor for subsystems using ConfigSource (e.g.
protected	SubsystemConfig(S subsystem, @NotNull String resourcePath)

Method Summary

Modifier and Type	Method	Description
static @NotNull InputStream	getIS(@NotNull AbstractSubsystem<?,?> subsystem, @NotNull String resourcePath)	Helper method to get a resource InputStream from a subsystem's plugin.
@NotNull Location	getLocation(String key)	Reads a Location from the current config file using the standard location format.
S	getSubsystem()

Methods inherited from class KamiConfigExt

applyThisPlaceholders, getString, getString, getStringList, getStringList

Methods inherited from class KamiConfig

addDefault, contains, get, get, getBigDecimal, getBigDecimal, getBoolean, getBoolean, getByte, getByte, getByteList, getByteList, getConfigurationSection, getConfigurationSequence, getCurrentPath, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getIntegerList, getIntegerList, getItemStack, getItemStack, getKeys, getList, getList, getLong, getLong, getShort, getShort, getSource, getYamlConfiguration, isBoolean, isByte, isConfigurationSection, isDouble, isEmpty, isFloat, isInt, isItemStack, isList, isLong, isNumber, isSet, isShort, isString, parseItemBuilder, put, putBoolean, putByte, putDouble, putFloat, putInt, putInteger, putLong, putShort, putString, registerConfigObserver, reload, reloadObservableConfig, set, setBoolean, setByte, setDouble, setFloat, setInt, setInteger, setItemStack, setLong, setShort, setString, unregisterConfigObserver, unregisterConfigObservers

Methods inherited from class AbstractConfig

isChanged, save, save, setChanged

Methods inherited from class Object

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

Methods inherited from interface ConfigurationMethods

isChanged, setChanged

Constructor Details

SubsystemConfig

protected SubsystemConfig(@NotNull
 S subsystem,
 @NotNull
 @NotNull String resourcePath)

SubsystemConfig

protected SubsystemConfig(@NotNull
 S subsystem,
 @NotNull
 @NotNull ConfigSource source,
 @NotNull
 @NotNull String resourcePath)

Constructor for subsystems using ConfigSource (e.g. from a database or other source)

Parameters:

subsystem - The parent subsystem

source - The config source where the yaml contents will be read from

resourcePath - The resource path to the default config file inside the plugin jar

Method Details

getIS

@NotNull
public static @NotNull InputStream getIS(@NotNull
 @NotNull AbstractSubsystem<?,?> subsystem,
 @NotNull
 @NotNull String resourcePath)

Helper method to get a resource InputStream from a subsystem's plugin.

getSubsystem

@NotNull
public S getSubsystem()

getLocation

@NotNull
public @NotNull Location getLocation(String key)
                              throws IllegalArgumentException

Reads a Location from the current config file using the standard location format.

Parameters:

key - The root key of the location in the config file, e.g. "spawn" which has subkeys: "spawn.x", "spawn.y", etc.

Throws:

IllegalArgumentException