| Package | Description |
|---|---|
| org.bspfsystems.yamlconfiguration.configuration | |
| org.bspfsystems.yamlconfiguration.file |
| Modifier and Type | Interface and Description |
|---|---|
interface |
Configuration
Represents a source of configurable options and settings.
|
| Modifier and Type | Class and Description |
|---|---|
class |
MemoryConfiguration
Represents an implementation of a configuration that exists only in-memory.
|
class |
MemorySection
Represents an implementation of a configuration section that is only stored
in-memory.
|
| Modifier and Type | Method and Description |
|---|---|
@NotNull ConfigurationSection |
MemorySection.createSection(@NotNull String path)
Creates an empty configuration section at the given path.
|
@NotNull ConfigurationSection |
ConfigurationSection.createSection(@NotNull String path)
Creates an empty configuration section at the given path.
|
@NotNull ConfigurationSection |
MemorySection.createSection(@NotNull String path,
@NotNull Map<?,?> map)
Creates a configuration section at the given path, with the given values.
|
@NotNull ConfigurationSection |
ConfigurationSection.createSection(@NotNull String path,
@NotNull Map<?,?> entries)
Creates a configuration section at the given path, with the given values.
|
@Nullable ConfigurationSection |
MemorySection.getConfigurationSection(@NotNull String path)
Gets the configuration section value at the given path.
|
@Nullable ConfigurationSection |
ConfigurationSection.getConfigurationSection(@NotNull String path)
Gets the configuration section value at the given path.
|
@Nullable ConfigurationSection |
MemorySection.getDefaultSection()
Gets the equivalent configuration section from the default configuration
defined in
getRoot(). |
@Nullable ConfigurationSection |
ConfigurationSection.getDefaultSection()
Gets the equivalent configuration section from the default configuration
defined in
getRoot(). |
@Nullable ConfigurationSection |
MemorySection.getParent()
Gets the parent configuration section that directly contains this
section.
|
@Nullable ConfigurationSection |
MemoryConfiguration.getParent()
Gets the parent configuration section that directly contains this
section.
|
@Nullable ConfigurationSection |
ConfigurationSection.getParent()
Gets the parent configuration section that directly contains this
section.
|
| Modifier and Type | Method and Description |
|---|---|
static @NotNull String |
MemorySection.createPath(@NotNull ConfigurationSection section,
@Nullable String key)
Creates a full path to the given configuration section from its root
configuration.
|
static @NotNull String |
MemorySection.createPath(@NotNull ConfigurationSection section,
@Nullable String key,
@Nullable ConfigurationSection relative)
Creates a relative path to the given configuration section from the given
relative section.
|
static @NotNull String |
MemorySection.createPath(@NotNull ConfigurationSection section,
@Nullable String key,
@Nullable ConfigurationSection relative)
Creates a relative path to the given configuration section from the given
relative section.
|
| Modifier and Type | Class and Description |
|---|---|
class |
FileConfiguration
Represents a base class for all file-based implementations of a memory
configuration.
|
class |
YamlConfiguration
Represents an implementation of configuration which saves all files in valid
YAML format.
|
Copyright © 2024 BSPF Systems, LLC. All rights reserved.