Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- addClassTag(Class<? extends Object>, Tag) - Method in class org.bspfsystems.yamlconfiguration.file.YamlRepresenter
- addDefault(String, Object) - Method in interface org.bspfsystems.yamlconfiguration.configuration.Configuration
-
Sets the default value of the given path as provided.
- addDefault(String, Object) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Sets the default value in the root at the given path as provided.
- addDefault(String, Object) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemoryConfiguration
-
Sets the default value in the root at the given path as provided.
- addDefault(String, Object) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Sets the default value in the root at the given path as provided.
- addDefaults(Map<String, Object>) - Method in interface org.bspfsystems.yamlconfiguration.configuration.Configuration
-
Sets the default values of the given paths as provided.
- addDefaults(Map<String, Object>) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemoryConfiguration
-
Sets the default values of the given paths as provided.
- addDefaults(Configuration) - Method in interface org.bspfsystems.yamlconfiguration.configuration.Configuration
-
Sets the default values of the given paths as provided.
- addDefaults(Configuration) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemoryConfiguration
-
Sets the default values of the given paths as provided.
C
- classTags - Variable in class org.bspfsystems.yamlconfiguration.file.YamlRepresenter
- clear() - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Clears the internal map.
- Configuration - Interface in org.bspfsystems.yamlconfiguration.configuration
-
Represents a source of configurable options and settings.
- ConfigurationOptions - Class in org.bspfsystems.yamlconfiguration.configuration
-
Represents the various settings for controlling the input and output of a configuration.
- ConfigurationOptions(Configuration) - Constructor for class org.bspfsystems.yamlconfiguration.configuration.ConfigurationOptions
-
Constructs a set of configuration options.
- ConfigurationSection - Interface in org.bspfsystems.yamlconfiguration.configuration
-
Represents a section of a configuration.
- ConfigurationSerializable - Interface in org.bspfsystems.yamlconfiguration.serialization
-
Represents an object that may be serialized.
- ConfigurationSerialization - Class in org.bspfsystems.yamlconfiguration.serialization
-
A utility class for storing and retrieving classes for configurations.
- contains(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Checks if this configuration section contains the given path.
- contains(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Checks if this configuration section contains the given path.
- contains(String, boolean) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Checks if this configuration section contains the given path.
- contains(String, boolean) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Checks if this configuration section contains the given path.
- createPath(ConfigurationSection, String) - Static method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Creates a full path to the given configuration section from its root configuration.
- createPath(ConfigurationSection, String, ConfigurationSection) - Static method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Creates a relative path to the given configuration section from the given relative section.
- createSection(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Creates an empty configuration section at the given path.
- createSection(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Creates an empty configuration section at the given path.
- createSection(String, Map<?, ?>) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Creates a configuration section at the given path, with the given values.
- createSection(String, Map<?, ?>) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Creates a configuration section at the given path, with the given values.
D
- DEFAULT_CODE_POINT_LIMIT - Static variable in class org.bspfsystems.yamlconfiguration.file.YamlConfigurationOptions
- DEFAULT_COPY_DEFAULTS - Static variable in class org.bspfsystems.yamlconfiguration.configuration.ConfigurationOptions
- DEFAULT_FOOTER - Static variable in class org.bspfsystems.yamlconfiguration.file.FileConfigurationOptions
- DEFAULT_HEADER - Static variable in class org.bspfsystems.yamlconfiguration.file.FileConfigurationOptions
- DEFAULT_INDENT - Static variable in class org.bspfsystems.yamlconfiguration.file.YamlConfigurationOptions
- DEFAULT_MAX_ALIASES - Static variable in class org.bspfsystems.yamlconfiguration.file.YamlConfigurationOptions
- DEFAULT_PARSE_COMMENTS - Static variable in class org.bspfsystems.yamlconfiguration.file.FileConfigurationOptions
- DEFAULT_PATH_SEPARATOR - Static variable in class org.bspfsystems.yamlconfiguration.configuration.ConfigurationOptions
- DEFAULT_WIDTH - Static variable in class org.bspfsystems.yamlconfiguration.file.YamlConfigurationOptions
- defs - Variable in class org.bspfsystems.yamlconfiguration.configuration.MemoryConfiguration
- DelegateDeserialization - Annotation Interface in org.bspfsystems.yamlconfiguration.serialization
-
Applies to a configuration serializable that will delegate all deserialization to another configuration serializable.
- deserializeObject(Map<String, ?>) - Static method in class org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerialization
-
Attempts to deserialize the given map into a new instance of any known type of configuration serializable that may be indicated by the data contained within the map itself.
- deserializeObject(Map<String, ?>, Class<? extends ConfigurationSerializable>) - Static method in class org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerialization
-
Attempts to deserialize the given map into a new instance of the given class.
F
- FileConfiguration - Class in org.bspfsystems.yamlconfiguration.file
-
Represents a base class for all file-based implementations of a memory configuration.
- FileConfiguration() - Constructor for class org.bspfsystems.yamlconfiguration.file.FileConfiguration
-
Constructs an empty file configuration with no default values.
- FileConfiguration(Configuration) - Constructor for class org.bspfsystems.yamlconfiguration.file.FileConfiguration
-
Constructs an empty file configuration using the given configuration as a source for all default values.
- FileConfigurationOptions - Class in org.bspfsystems.yamlconfiguration.file
-
Represents the various settings for controlling the input and output of a file configuration.
- FileConfigurationOptions(MemoryConfiguration) - Constructor for class org.bspfsystems.yamlconfiguration.file.FileConfigurationOptions
-
Constructs a set of file configuration options.
- flattenMapping(MappingNode) - Method in class org.bspfsystems.yamlconfiguration.file.YamlConstructor
G
- get(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the value at the given path.
- get(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the value at the given path.
- get(String, Object) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the value at the given path, returning the given default value if one has not been set.
- get(String, Object) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the value at the given path, returning the given default value if one has not been set.
- getAlias(Class<? extends ConfigurationSerializable>) - Static method in class org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerialization
-
Gets the primary alias for the given configuration serializable class.
- getBoolean(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the boolean value at the given path.
- getBoolean(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the boolean value at the given path.
- getBoolean(String, boolean) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the boolean value at the given path.
- getBoolean(String, boolean) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the boolean value at the given path.
- getBooleanList(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the list of booleans at the given path.
- getBooleanList(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the list of booleans at the given path.
- getByte(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the byte value at the given path.
- getByte(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the byte value at the given path.
- getByte(String, byte) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the byte value at the given path.
- getByte(String, byte) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the byte value at the given path.
- getByteList(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the list of bytes at the given path.
- getByteList(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the list of bytes at the given path.
- getChar(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the char value at the given path.
- getChar(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the char value at the given path.
- getChar(String, char) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the char value at the given path.
- getChar(String, char) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the char value at the given path.
- getCharList(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the list of chars at the given path.
- getCharList(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the list of chars at the given path.
- getClassByAlias(String) - Static method in class org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerialization
-
Attempts to get a registered configuration serializable class by its alias.
- getCodePointLimit() - Method in class org.bspfsystems.yamlconfiguration.file.YamlConfigurationOptions
-
Gets the maximum number of code points that can be loaded in at one time.
- getComments(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the comments by path.
- getComments(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the comments by path.
- getConfiguration() - Method in class org.bspfsystems.yamlconfiguration.configuration.ConfigurationOptions
-
Gets the configuration that these options controls.
- getConfiguration() - Method in class org.bspfsystems.yamlconfiguration.configuration.MemoryConfigurationOptions
-
Gets the configuration that these options controls.
- getConfiguration() - Method in class org.bspfsystems.yamlconfiguration.file.FileConfigurationOptions
-
Gets the configuration that these options controls.
- getConfiguration() - Method in class org.bspfsystems.yamlconfiguration.file.YamlConfigurationOptions
-
Gets the configuration that these options controls.
- getConfigurationSection(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the configuration section value at the given path.
- getConfigurationSection(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the configuration section value at the given path.
- getCopyDefaults() - Method in class org.bspfsystems.yamlconfiguration.configuration.ConfigurationOptions
-
Checks if the configuration should copy values from its default configuration directly.
- getCurrentPath() - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the path of this configuration section from its root configuration.
- getCurrentPath() - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the path of this configuration section from its root configuration.
- getDefaults() - Method in interface org.bspfsystems.yamlconfiguration.configuration.Configuration
-
Gets the default configuration for this configuration.
- getDefaults() - Method in class org.bspfsystems.yamlconfiguration.configuration.MemoryConfiguration
-
Gets the default configuration for this configuration.
- getDefaultSection() - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the equivalent configuration section from the default configuration defined in
ConfigurationSection.getRoot(). - getDefaultSection() - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the equivalent configuration section from the default configuration defined in
ConfigurationSection.getRoot(). - getDouble(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the double value at the given path.
- getDouble(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the double value at the given path.
- getDouble(String, double) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the double value at the given path.
- getDouble(String, double) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the double value at the given path.
- getDoubleList(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the list of doubles at the given path.
- getDoubleList(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the list of doubles at the given path.
- getFloat(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the float value at the given path.
- getFloat(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the float value at the given path.
- getFloat(String, float) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the float value at the given path.
- getFloat(String, float) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the float value at the given path.
- getFloatList(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the list of floats at the given path.
- getFloatList(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the list of floats at the given path.
- getFooter() - Method in class org.bspfsystems.yamlconfiguration.file.FileConfigurationOptions
-
Gets the footer comments that will be saved at the top of the output file configuration.
- getHeader() - Method in class org.bspfsystems.yamlconfiguration.file.FileConfigurationOptions
-
Gets the header comments that will be saved at the top of the output file configuration.
- getIndent() - Method in class org.bspfsystems.yamlconfiguration.file.YamlConfigurationOptions
-
Gets the number of spaces used to represent an indent.
- getInlineComments(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the inline comments by path.
- getInlineComments(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the inline comments by path.
- getInt(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the int value at the given path.
- getInt(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the int value at the given path.
- getInt(String, int) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the int value at the given path.
- getInt(String, int) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the int value at the given path.
- getIntList(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the list of ints at the given path.
- getIntList(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the list of ints at the given path.
- getKeys(boolean) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets a set containing a copy of all keys in this configuration section.
- getKeys(boolean) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets a set containing a copy of all keys in this configuration section.
- getList(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the list value at the given path.
- getList(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the list value at the given path.
- getList(String, List<?>) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the list value at the given path.
- getList(String, List<?>) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the list value at the given path.
- getLong(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the long value at the given path.
- getLong(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the long value at the given path.
- getLong(String, long) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the long value at the given path.
- getLong(String, long) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the long value at the given path.
- getLongList(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the list of longs at the given path.
- getLongList(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the list of longs at the given path.
- getMapList(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the list of maps at the given path.
- getMapList(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the list of maps at the given path.
- getMaxAliases() - Method in class org.bspfsystems.yamlconfiguration.file.YamlConfigurationOptions
-
Gets the maximum number of aliases for collections.
- getName() - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the name of this individual configuration section in its path.
- getName() - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the name of this individual configuration section in its path.
- getObject(String, Class<T>) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the value of type
Tat the given path. - getObject(String, Class<T>) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the value of type
Tat the given path. - getObject(String, Class<T>, T) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the value of type
Tat the given path. - getObject(String, Class<T>, T) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the value of type
Tat the given path. - getOptions() - Method in interface org.bspfsystems.yamlconfiguration.configuration.Configuration
-
Gets the options for this configuration.
- getOptions() - Method in class org.bspfsystems.yamlconfiguration.configuration.MemoryConfiguration
-
Gets the options for this configuration.
- getOptions() - Method in class org.bspfsystems.yamlconfiguration.file.FileConfiguration
-
Gets the options for this configuration.
- getOptions() - Method in class org.bspfsystems.yamlconfiguration.file.YamlConfiguration
-
Gets the options for this configuration.
- getParent() - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the parent configuration section that directly contains this section.
- getParent() - Method in class org.bspfsystems.yamlconfiguration.configuration.MemoryConfiguration
-
Gets the parent configuration section that directly contains this section.
- getParent() - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the parent configuration section that directly contains this section.
- getParseComments() - Method in class org.bspfsystems.yamlconfiguration.file.FileConfigurationOptions
-
Gets whether the comments (header, block, inline, and/or footer) in a file configuration should be loaded and saved.
- getPathSeparator() - Method in class org.bspfsystems.yamlconfiguration.configuration.ConfigurationOptions
-
Gets the
charthat will be used to separate configuration sections. - getRoot() - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the root configuration that contains this configuration section.
- getRoot() - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the root configuration that contains this configuration section.
- getSerializable(String, Class<T>) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the configuration serializable value of type
Tat the given path. - getSerializable(String, Class<T>) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the configuration serializable value of type
Tat the given path. - getSerializable(String, Class<T>, T) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the configuration serializable value of type
Tvalue at the given path. - getSerializable(String, Class<T>, T) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the configuration serializable value of type
Tvalue at the given path. - getShort(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the short value at the given path.
- getShort(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the short value at the given path.
- getShort(String, short) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the short value at the given path.
- getShort(String, short) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the short value at the given path.
- getShortList(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the list of shorts at the given path.
- getShortList(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the list of shorts at the given path.
- getString(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the string value at the given path.
- getString(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the string value at the given path.
- getString(String, String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the string value at the given path.
- getString(String, String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the string value at the given path.
- getStringList(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets the list of strings at the given path.
- getStringList(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets the list of strings at the given path.
- getTag(Class<?>, Tag) - Method in class org.bspfsystems.yamlconfiguration.file.YamlRepresenter
- getTimeZone() - Method in class org.bspfsystems.yamlconfiguration.file.YamlRepresenter
- getValues(boolean) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Gets a map containing a copy of all keys and their respective values for this configuration section.
- getValues(boolean) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Gets a map containing a copy of all keys and their respective values for this configuration section.
- getWidth() - Method in class org.bspfsystems.yamlconfiguration.file.YamlConfigurationOptions
-
Gets how long a line can be before it gets split.
I
- InvalidConfigurationException - Exception in org.bspfsystems.yamlconfiguration.configuration
-
An exception thrown when attempting to load an invalid configuration.
- InvalidConfigurationException() - Constructor for exception org.bspfsystems.yamlconfiguration.configuration.InvalidConfigurationException
-
Constructs an exception without a message or cause.
- InvalidConfigurationException(String) - Constructor for exception org.bspfsystems.yamlconfiguration.configuration.InvalidConfigurationException
-
Constructs an exception with a message.
- InvalidConfigurationException(String, Throwable) - Constructor for exception org.bspfsystems.yamlconfiguration.configuration.InvalidConfigurationException
-
Constructs an exception with a message and upstream cause.
- InvalidConfigurationException(Throwable) - Constructor for exception org.bspfsystems.yamlconfiguration.configuration.InvalidConfigurationException
-
Constructs an exception with an upstream cause.
- isBoolean(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Checks if the value at the given path is a boolean.
- isBoolean(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Checks if the value at the given path is a boolean.
- isByte(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Checks if the value at the given path is a byte.
- isByte(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Checks if the value at the given path is a byte.
- isChar(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Checks if the value at the given path is a char.
- isChar(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Checks if the value at the given path is a char.
- isConfigurationSection(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Checks if the value at the given path is a configuration section.
- isConfigurationSection(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Checks if the value at the given path is a configuration section.
- isDouble(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Checks if the value at the given path is a double.
- isDouble(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Checks if the value at the given path is a double.
- isFloat(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Checks if the value at the given path is a float.
- isFloat(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Checks if the value at the given path is a float.
- isInt(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Checks if the value at the given path is an int.
- isInt(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Checks if the value at the given path is an int.
- isList(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Checks if the value at the given path is a generic list.
- isList(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Checks if the value at the given path is a generic list.
- isLong(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Checks if the value at the given path is a long.
- isLong(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Checks if the value at the given path is a long.
- isNumber(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Checks if the value at the given path is a number.
- isNumber(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Checks if the value at the given path is a number.
- isSet(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Checks if this configuration section has a value set for the given path.
- isSet(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Checks if this configuration section has a value set for the given path.
- isShort(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Checks if the value at the given path is a short.
- isShort(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Checks if the value at the given path is a short.
- isString(String) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Checks if the value at the given path is a string.
- isString(String) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Checks if the value at the given path is a string.
L
- load(File) - Method in class org.bspfsystems.yamlconfiguration.file.FileConfiguration
-
Loads this file configuration from the given file.
- load(Reader) - Method in class org.bspfsystems.yamlconfiguration.file.FileConfiguration
-
Loads this file configuration from the given reader.
- load(String) - Method in class org.bspfsystems.yamlconfiguration.file.FileConfiguration
-
Loads this file configuration from the file at the given path.
- loadConfiguration(File) - Static method in class org.bspfsystems.yamlconfiguration.file.YamlConfiguration
-
Creates a new YAML configuration, loading from the given file.
- loadConfiguration(Reader) - Static method in class org.bspfsystems.yamlconfiguration.file.YamlConfiguration
-
Creates a new YAML configuration, loading from the given reader.
- loadFromString(String) - Method in class org.bspfsystems.yamlconfiguration.file.FileConfiguration
-
Loads this file configuration from the given string.
- loadFromString(String) - Method in class org.bspfsystems.yamlconfiguration.file.YamlConfiguration
-
Loads this file configuration from the given string.
M
- MemoryConfiguration - Class in org.bspfsystems.yamlconfiguration.configuration
-
Represents an implementation of a configuration that exists only in-memory.
- MemoryConfiguration() - Constructor for class org.bspfsystems.yamlconfiguration.configuration.MemoryConfiguration
-
Constructs an empty memory configuration with no default values.
- MemoryConfiguration(Configuration) - Constructor for class org.bspfsystems.yamlconfiguration.configuration.MemoryConfiguration
-
Constructs an empty memory configuration using the given configuration as a source for all default values.
- MemoryConfigurationOptions - Class in org.bspfsystems.yamlconfiguration.configuration
-
Represents the various settings for controlling the input and output of a memory configuration.
- MemoryConfigurationOptions(MemoryConfiguration) - Constructor for class org.bspfsystems.yamlconfiguration.configuration.MemoryConfigurationOptions
-
Constructs a set of memory configuration options.
- MemorySection - Class in org.bspfsystems.yamlconfiguration.configuration
-
Represents an implementation of a configuration section that is only stored in-memory.
- MemorySection() - Constructor for class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Constructs an empty memory section for use as a root configuration section.
N
- nonPrintableStyle - Variable in class org.bspfsystems.yamlconfiguration.file.YamlRepresenter
O
- options - Variable in class org.bspfsystems.yamlconfiguration.configuration.MemoryConfiguration
- org.bspfsystems.yamlconfiguration - module org.bspfsystems.yamlconfiguration
-
Declares the YAML configuration module and handles dependencies and exports.
- org.bspfsystems.yamlconfiguration.configuration - package org.bspfsystems.yamlconfiguration.configuration
- org.bspfsystems.yamlconfiguration.file - package org.bspfsystems.yamlconfiguration.file
- org.bspfsystems.yamlconfiguration.serialization - package org.bspfsystems.yamlconfiguration.serialization
R
- registerClass(Class<? extends ConfigurationSerializable>) - Static method in class org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerialization
-
Registers the given configuration serializable class by any and all aliases/delegate deserializations.
- registerClass(Class<? extends ConfigurationSerializable>, String) - Static method in class org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerialization
-
Registers the given alias to the given configuration serializable class.
S
- save(File) - Method in class org.bspfsystems.yamlconfiguration.file.FileConfiguration
-
Saves this file configuration to the given file.
- save(String) - Method in class org.bspfsystems.yamlconfiguration.file.FileConfiguration
-
Saves this file configuration to the given file.
- saveToString() - Method in class org.bspfsystems.yamlconfiguration.file.FileConfiguration
-
Converts this file configuration to a string.
- saveToString() - Method in class org.bspfsystems.yamlconfiguration.file.YamlConfiguration
-
Converts this file configuration to a string.
- SerializableAs - Annotation Interface in org.bspfsystems.yamlconfiguration.serialization
-
Represents an "alias" that a configuration serializable may be known as.
- serialize() - Method in interface org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable
-
Creates a map representation of this configuration serializable.
- SERIALIZED_TYPE_KEY - Static variable in class org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerialization
- set(String, Object) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Sets the given path to the given value.
- set(String, Object) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Sets the given path to the given value.
- setCodePointLimit(int) - Method in class org.bspfsystems.yamlconfiguration.file.YamlConfigurationOptions
-
Sets the maximum number of code points that can be loaded in at one time.
- setComments(String, List<String>) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Sets the comments at the given path.
- setComments(String, List<String>) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Sets the comments at the given path.
- setCopyDefaults(boolean) - Method in class org.bspfsystems.yamlconfiguration.configuration.ConfigurationOptions
-
Sets if the configuration should copy values from its default configuration directly.
- setCopyDefaults(boolean) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemoryConfigurationOptions
-
Sets if the configuration should copy values from its default configuration directly.
- setCopyDefaults(boolean) - Method in class org.bspfsystems.yamlconfiguration.file.FileConfigurationOptions
-
Sets if the configuration should copy values from its default configuration directly.
- setCopyDefaults(boolean) - Method in class org.bspfsystems.yamlconfiguration.file.YamlConfigurationOptions
-
Sets if the configuration should copy values from its default configuration directly.
- setDefaults(Configuration) - Method in interface org.bspfsystems.yamlconfiguration.configuration.Configuration
-
Sets the source of all default values for this configuration.
- setDefaults(Configuration) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemoryConfiguration
-
Sets the source of all default values for this configuration.
- setFooter(List<String>) - Method in class org.bspfsystems.yamlconfiguration.file.FileConfigurationOptions
-
Assigns the given footer comments to these file configuration options.
- setFooter(List<String>) - Method in class org.bspfsystems.yamlconfiguration.file.YamlConfigurationOptions
-
Assigns the given footer comments to these file configuration options.
- setHeader(List<String>) - Method in class org.bspfsystems.yamlconfiguration.file.FileConfigurationOptions
-
Assigns the given header comments to these file configuration options.
- setHeader(List<String>) - Method in class org.bspfsystems.yamlconfiguration.file.YamlConfigurationOptions
-
Assigns the given header comments to these file configuration options.
- setIndent(int) - Method in class org.bspfsystems.yamlconfiguration.file.YamlConfigurationOptions
-
Sets the number of spaces used to represent an indent.
- setInlineComments(String, List<String>) - Method in interface org.bspfsystems.yamlconfiguration.configuration.ConfigurationSection
-
Sets the inline comments at the given path.
- setInlineComments(String, List<String>) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Sets the inline comments at the given path.
- setMaxAliases(int) - Method in class org.bspfsystems.yamlconfiguration.file.YamlConfigurationOptions
-
Sets the maximum number of aliases for collections.
- setParseComments(boolean) - Method in class org.bspfsystems.yamlconfiguration.file.FileConfigurationOptions
-
Sets whether the comments (header, block, inline, and/or footer) in a file configuration should be loaded and saved.
- setParseComments(boolean) - Method in class org.bspfsystems.yamlconfiguration.file.YamlConfigurationOptions
-
Sets whether the comments (header, block, inline, and/or footer) in a file configuration should be loaded and saved.
- setPathSeparator(char) - Method in class org.bspfsystems.yamlconfiguration.configuration.ConfigurationOptions
-
Sets the
charthat will be used to separate configuration sections. - setPathSeparator(char) - Method in class org.bspfsystems.yamlconfiguration.configuration.MemoryConfigurationOptions
-
Sets the
charthat will be used to separate configuration sections. - setPathSeparator(char) - Method in class org.bspfsystems.yamlconfiguration.file.FileConfigurationOptions
-
Sets the
charthat will be used to separate configuration sections. - setPathSeparator(char) - Method in class org.bspfsystems.yamlconfiguration.file.YamlConfigurationOptions
-
Sets the
charthat will be used to separate configuration sections. - setTimeZone(TimeZone) - Method in class org.bspfsystems.yamlconfiguration.file.YamlRepresenter
- setWidth(int) - Method in class org.bspfsystems.yamlconfiguration.file.YamlConfigurationOptions
-
Sets how long a line can be before it gets split.
T
- timeZone - Variable in class org.bspfsystems.yamlconfiguration.file.YamlRepresenter
- toString() - Method in class org.bspfsystems.yamlconfiguration.configuration.MemorySection
-
Creates a string representation of this memory section.
U
- unregisterClass(Class<? extends ConfigurationSerializable>) - Static method in class org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerialization
-
Unregisters any aliases for the given configuration serializable class
- unregisterClass(String) - Static method in class org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerialization
-
Unregisters the specified alias.
V
- value() - Element in annotation interface org.bspfsystems.yamlconfiguration.serialization.DelegateDeserialization
-
Gets the configuration serializable class that is delegated to.
- value() - Element in annotation interface org.bspfsystems.yamlconfiguration.serialization.SerializableAs
-
This is the name the configuration serializable class will be known by.
Y
- YamlConfiguration - Class in org.bspfsystems.yamlconfiguration.file
-
Represents an implementation of configuration which saves all files in valid YAML format.
- YamlConfiguration() - Constructor for class org.bspfsystems.yamlconfiguration.file.YamlConfiguration
-
Constructs an empty YAML configuration with no default values.
- YamlConfiguration(Configuration) - Constructor for class org.bspfsystems.yamlconfiguration.file.YamlConfiguration
-
Constructs an empty YAML configuration using the given configuration as a source for all default values.
- YamlConfigurationOptions - Class in org.bspfsystems.yamlconfiguration.file
-
Represents the various settings for controlling the input and output of a YAML configuration.
- YamlConstructor - Class in org.bspfsystems.yamlconfiguration.file
-
Represents a custom safe constructor for use with a YAML configuration.
- YamlRepresenter - Class in org.bspfsystems.yamlconfiguration.file
-
Represents a representer that can work with configuration sections and configuration serializables.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form