Index
All Classes and Interfaces|All Packages
A
- at(PathProvider) - Method in class me.a8kj.config.builder.BasicConfigBuilder
-
Sets the path provider used to resolve the physical location of the file.
- at(PathProvider) - Method in class me.a8kj.config.builder.PairedConfigBuilder
-
Sets the path provider used to determine the storage location of the configuration file.
- at(PathProvider) - Method in class me.a8kj.config.builder.StringConfigBuilder
-
Sets the provider responsible for resolving the configuration's file path.
- AutoReadBukkitConfig - Class in me.a8kj.config.file
-
An extended implementation of
BasicBukkitConfigthat automatically triggers aBasicBukkitConfig.read()operation immediately after the file is created. - AutoReadBukkitConfig() - Constructor for class me.a8kj.config.file.AutoReadBukkitConfig
- AutoReadYamlSource - Class in me.a8kj.config
-
Provides an automated YAML configuration source that triggers a read operation immediately after creation.
- AutoReadYamlSource() - Constructor for class me.a8kj.config.AutoReadYamlSource
B
- BaseConfig<K> - Class in me.a8kj.config.file
-
An abstract base implementation of
CRUDOperationsproviding core file management logic. - BaseConfig() - Constructor for class me.a8kj.config.file.BaseConfig
- BaseMapperOperator - Class in me.a8kj.config.template.experimental.mapper
-
An abstract base implementation of
MapperOperatorContractthat handles codec registration and provides core logic for entity serialization and deserialization. - BaseMapperOperator() - Constructor for class me.a8kj.config.template.experimental.mapper.BaseMapperOperator
- BasicBukkitConfig - Class in me.a8kj.config.file
-
A standard implementation of
BukkitConfigspecifically designed for YAML files. - BasicBukkitConfig() - Constructor for class me.a8kj.config.file.BasicBukkitConfig
- BasicConfigBuilder<K> - Class in me.a8kj.config.builder
-
A builder class for creating instances of
ConfigFileusing a fluent API. - BasicConfigBuilder() - Constructor for class me.a8kj.config.builder.BasicConfigBuilder
- BasicConfigExecutionContext<K> - Class in me.a8kj.config.context.impl
-
Standard implementation of
ConfigExecutionContext. - BasicConfigExecutionContext() - Constructor for class me.a8kj.config.context.impl.BasicConfigExecutionContext
- BasicConfigFile<K> - Record Class in me.a8kj.config.file.impl
-
A fundamental implementation of
ConfigFileusing Java Records. - BasicConfigFile(ConfigMeta, File, DataMemory<K>) - Constructor for record class me.a8kj.config.file.impl.BasicConfigFile
-
Creates an instance of a
BasicConfigFilerecord class. - BasicConfigMeta - Class in me.a8kj.config.file.properties
-
A standard implementation of
ConfigMetausing the Builder pattern. - BasicConfigMeta() - Constructor for class me.a8kj.config.file.properties.BasicConfigMeta
- BasicConfigOperationExecutor<K> - Class in me.a8kj.config.file.operation
-
A standard implementation of
ConfigOperationExecutorthat orchestrates the execution of configuration operations with integrated logging and error handling. - BasicConfigOperationExecutor() - Constructor for class me.a8kj.config.file.operation.BasicConfigOperationExecutor
- BasicVelocityConfig - Class in me.a8kj.config.file.impl
-
A specialized implementation of configuration for Velocity using Configurate 4.
- BasicVelocityConfig() - Constructor for class me.a8kj.config.file.impl.BasicVelocityConfig
- BOOLEAN - Enum constant in enum class me.a8kj.config.template.memory.MemoryDataType
-
Handles retrieval of boolean flags with a default of false.
- brackets() - Static method in record class me.a8kj.config.template.replacement.impl.PlaceholderProcessor
-
Creates a processor for bracket-style placeholders:
{key}. - build() - Method in class me.a8kj.config.builder.BasicConfigBuilder
-
Validates the provided components and builds a
BasicConfigFileinstance. - build() - Method in class me.a8kj.config.builder.PairedConfigBuilder
-
Validates all required components and creates a new
ConfigFileinstance. - build() - Method in class me.a8kj.config.builder.StringConfigBuilder
-
Constructs the final
ConfigFilewith a guaranteed string-based memory. - BukkitConfig<K> - Class in me.a8kj.config.file
- BukkitConfig() - Constructor for class me.a8kj.config.file.BukkitConfig
- BukkitConfigAPI - Class in me.a8kj.config
- BukkitConfigAPI() - Constructor for class me.a8kj.config.BukkitConfigAPI
C
- callEvent(Event) - Method in interface me.a8kj.config.ConfigAPI
-
Calls an event and dispatches it to all registered listeners.
- chevron() - Static method in record class me.a8kj.config.template.replacement.impl.PlaceholderProcessor
-
Creates a processor for chevron-style placeholders:
<key>. - clear() - Method in interface me.a8kj.config.template.memory.DataMemory
-
Clears all data currently held in memory.
- clear() - Method in class me.a8kj.config.template.memory.impl.EnumDataMemory
- clear() - Method in class me.a8kj.config.template.memory.impl.GenericMapDataMemory
- clear() - Method in class me.a8kj.config.template.memory.impl.MapDataMemory
- clear() - Method in class me.a8kj.config.template.memory.impl.MapPairedDataMemory
- clear() - Method in class me.a8kj.config.template.memory.impl.StringMapPairedDataMemory
- CodecAdapter<T,
S> - Class in me.a8kj.config.template.experimental.codec -
Provides a unified abstraction for bidirectional data transformation between domain objects and their serialized representations.
- CodecAdapter() - Constructor for class me.a8kj.config.template.experimental.codec.CodecAdapter
- CodecRegistry - Interface in me.a8kj.config.template.experimental.mapper
-
Defines a registry for managing and retrieving codecs used in entity mapping.
- config() - Method in interface me.a8kj.config.context.ConfigExecutionContext
-
Retrieves the underlying configuration file.
- config() - Method in class me.a8kj.config.context.impl.BasicConfigExecutionContext
- ConfigAPI - Interface in me.a8kj.config
-
The core API interface for managing configurations and event handling.
- ConfigCreateEvent<K> - Class in me.a8kj.config.event.impl
-
Event triggered immediately after a configuration file has been successfully created on the disk.
- ConfigCreateEvent(ConfigFile<K>) - Constructor for class me.a8kj.config.event.impl.ConfigCreateEvent
-
Constructs a new ConfigCreateEvent.
- ConfigDeleteEvent<K> - Class in me.a8kj.config.event.impl
-
Event triggered immediately after a configuration file has been deleted from the disk.
- ConfigDeleteEvent(ConfigFile<K>) - Constructor for class me.a8kj.config.event.impl.ConfigDeleteEvent
-
Constructs a new ConfigDeleteEvent.
- ConfigEvent<K> - Class in me.a8kj.config.event
-
Abstract base class for all configuration-related events.
- ConfigEvent() - Constructor for class me.a8kj.config.event.ConfigEvent
- ConfigExecutionContext<K> - Interface in me.a8kj.config.context
-
Interface defining the execution context for configuration operations.
- ConfigFile<K> - Interface in me.a8kj.config.file
-
Represents a configuration file as a unified object.
- ConfigLoadEvent<K> - Class in me.a8kj.config.event.impl
-
Event triggered when a configuration file's data has been successfully loaded into memory.
- ConfigLoadEvent(ConfigFile<K>) - Constructor for class me.a8kj.config.event.impl.ConfigLoadEvent
-
Constructs a new ConfigLoadEvent.
- ConfigMeta - Interface in me.a8kj.config.file.properties
-
Defines the metadata and properties associated with a configuration file.
- ConfigOperation<K> - Interface in me.a8kj.config.file.operation
-
A functional interface representing a single operation to be performed on a
ConfigFile. - ConfigOperationExecutor<K> - Interface in me.a8kj.config.file.operation
-
An executor interface responsible for dispatching and managing the execution of
ConfigOperations. - ConfigProvider - Class in me.a8kj.config
-
A static provider class that acts as a global access point for the
ConfigAPI. - ConfigProvider() - Constructor for class me.a8kj.config.ConfigProvider
- ConfigRegistry - Class in me.a8kj.config.template.registry
-
A thread-safe registry for managing
ConfigFileinstances. - ConfigRegistry() - Constructor for class me.a8kj.config.template.registry.ConfigRegistry
- ConfigSaveEvent<K> - Class in me.a8kj.config.event.impl
-
Event triggered immediately after a configuration file has been successfully saved to the disk.
- ConfigSaveEvent(ConfigFile<K>) - Constructor for class me.a8kj.config.event.impl.ConfigSaveEvent
-
Constructs a new ConfigSaveEvent.
- contains(E) - Method in class me.a8kj.config.template.memory.impl.EnumDataMemory
- contains(String) - Method in class me.a8kj.config.template.memory.impl.MapPairedDataMemory
- contains(String) - Method in class me.a8kj.config.template.memory.impl.StringMapPairedDataMemory
- contains(K) - Method in interface me.a8kj.config.template.memory.DataMemory
-
Checks if the memory contains a specific key.
- contains(K) - Method in class me.a8kj.config.template.memory.impl.GenericMapDataMemory
- contains(MemoryDataType) - Method in class me.a8kj.config.template.memory.impl.MapDataMemory
- CreatableConfig<K> - Interface in me.a8kj.config.file.operation.impl
-
Defines the capability for a configuration to be created.
- create() - Static method in class me.a8kj.config.builder.StringConfigBuilder
-
Static factory method to create a new instance of the string-based config builder.
- create() - Method in class me.a8kj.config.file.BaseConfig
-
Creates a
ConfigOperationfor initializing the configuration file. - create() - Method in interface me.a8kj.config.file.operation.impl.CreatableConfig
-
Provides the operation logic for creating the configuration.
- CRUDOperations<K> - Interface in me.a8kj.config.file.operation.impl
-
A comprehensive interface that aggregates all standard configuration life-cycle operations.
- currentDir() - Static method in class me.a8kj.config.file.PathProviders
-
Creates a provider that uses the current working directory of the application.
- custom(String) - Static method in class me.a8kj.config.file.PathProviders
-
Creates a provider that uses a custom string-based absolute path.
D
- DataMemory<K> - Interface in me.a8kj.config.template.memory
-
Represents the in-memory storage and retrieval system for configuration data.
- DefaultMapperOperator - Class in me.a8kj.config.template.experimental.mapper
-
A standard, out-of-the-box implementation of
MapperOperatorContract. - DefaultMapperOperator() - Constructor for class me.a8kj.config.template.experimental.mapper.DefaultMapperOperator
- DeletableConfig<K> - Interface in me.a8kj.config.file.operation.impl
-
Defines the capability for a configuration to be deleted.
- delete() - Method in class me.a8kj.config.file.BaseConfig
-
Creates a
ConfigOperationfor deleting the file and clearing memory. - delete() - Method in interface me.a8kj.config.file.operation.impl.DeletableConfig
-
Provides the operation logic for deleting the configuration.
- deserialize(S) - Method in class me.a8kj.config.template.experimental.codec.CodecAdapter
-
Deserializes the provided data into a domain object instance.
- deserialize(S) - Method in interface me.a8kj.config.template.experimental.codec.Deserializer
-
Deserializes the provided data into a domain object instance.
- Deserializer<T,
S> - Interface in me.a8kj.config.template.experimental.codec -
Defines a functional contract for reconstructing domain objects from their serialized representations.
- DOUBLE - Enum constant in enum class me.a8kj.config.template.memory.MemoryDataType
-
Handles retrieval of floating-point numbers with a default of 0.0.
E
- EntityAwareMemory - Interface in me.a8kj.config.template.experimental.mapper
-
An entity-aware extension of
DataMemorythat enables the storage and retrieval of complex domain objects using structured mapping logic. - EntityDataMemory - Class in me.a8kj.config.template.experimental.mapper
-
An implementation of
EntityAwareMemorythat integrates complex entity mapping with standard configuration memory management. - EntityDataMemory(MapperOperatorContract) - Constructor for class me.a8kj.config.template.experimental.mapper.EntityDataMemory
-
Constructs an
EntityDataMemorywith a specified mapper service and default percent-style placeholders (e.g., %key%). - EntityDataMemory(MapperOperatorContract, ReplacementProcessor) - Constructor for class me.a8kj.config.template.experimental.mapper.EntityDataMemory
-
Constructs an
EntityDataMemorywith a specified mapper service and replacement processor. - EntityLoader - Interface in me.a8kj.config.template.experimental.mapper
-
Defines the contract for reconstructing domain entities from a flattened configuration memory.
- EntitySaver - Interface in me.a8kj.config.template.experimental.mapper
-
Defines the contract for decomposing and persisting domain entities into a flattened configuration memory.
- entries() - Method in class me.a8kj.config.template.registry.ConfigRegistry
-
Returns an iterable collection of all registered entries as
Pairobjects. - entries() - Method in interface me.a8kj.util.Registry
-
Provides an iterable collection of all currently registered entries.
- EnumDataMemory<E> - Class in me.a8kj.config.template.memory.impl
-
An abstract implementation of
DataMemorythat uses anEnumMapas its internal storage. - EnumDataMemory(Class<E>) - Constructor for class me.a8kj.config.template.memory.impl.EnumDataMemory
-
Constructs a new EnumDataMemory instance.
- equals(Object) - Method in record class me.a8kj.config.file.impl.BasicConfigFile
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class me.a8kj.config.template.replacement.impl.PlaceholderProcessor
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class me.a8kj.config.template.replacement.Replacement
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class me.a8kj.util.Pair
-
Indicates whether some other object is "equal to" this one.
- execute(Function<CRUDOperations<K>, ConfigOperation<K>>) - Method in interface me.a8kj.config.context.ConfigExecutionContext
-
Executes a specific operation within this context.
- execute(Function<CRUDOperations<K>, ConfigOperation<K>>) - Method in class me.a8kj.config.context.impl.BasicConfigExecutionContext
- execute(ConfigFile<K>) - Method in interface me.a8kj.config.file.operation.ConfigOperation
-
Executes the specific logic of the operation on the provided configuration file.
- execute(ConfigOperation<K>) - Method in class me.a8kj.config.file.operation.BasicConfigOperationExecutor
-
Executes a given
ConfigOperationwhile managing the execution lifecycle. - execute(ConfigOperation<K>) - Method in interface me.a8kj.config.file.operation.ConfigOperationExecutor
-
Executes a single configuration operation.
- executeAll(ConfigOperation<K>...) - Method in interface me.a8kj.config.file.operation.ConfigOperationExecutor
-
Executes multiple configuration operations in the order they are provided.
F
- fetch(DataMemory<String>) - Method in class me.a8kj.config.template.memory.MemoryEntry
-
Fetches the value associated with this entry from the provided memory source.
- fetchDetailed(MemoryEntry<T>) - Method in interface me.a8kj.config.template.memory.impl.PairedDataMemory
-
Fetches a detailed result for a given
MemoryEntry. - fetchOrDefault(DataMemory<String>, T) - Method in class me.a8kj.config.template.memory.MemoryEntry
-
Fetches the value associated with this entry from the provided memory source.
- file() - Method in interface me.a8kj.config.file.ConfigFile
-
Retrieves the physical file object pointing to the configuration's location on the disk.
- file() - Method in record class me.a8kj.config.file.impl.BasicConfigFile
-
Returns the value of the
filerecord component. - findCodec(Class<T>) - Method in class me.a8kj.config.template.experimental.mapper.BaseMapperOperator
-
Attempts to find a suitable codec for the specified class type.
- flatten(String, Map<String, Object>, DataMemory<String>) - Static method in class me.a8kj.util.MapStructureUtils
-
Flattens a nested
Mapinto a flat structure using dot-separated keys.
G
- GenericMapDataMemory<K> - Class in me.a8kj.config.template.memory.impl
-
A flexible, map-based implementation of
DataMemorythat uses aHashMapfor internal storage. - GenericMapDataMemory() - Constructor for class me.a8kj.config.template.memory.impl.GenericMapDataMemory
- get(E) - Method in class me.a8kj.config.template.memory.impl.EnumDataMemory
- get(String) - Method in class me.a8kj.config.template.registry.ConfigRegistry
-
Retrieves a registered configuration file.
- get(String) - Method in interface me.a8kj.util.Registry
-
Retrieves the object associated with the given key.
- get(String) - Method in class me.a8kj.config.template.memory.impl.MapPairedDataMemory
- get(String) - Method in class me.a8kj.config.template.memory.impl.StringMapPairedDataMemory
- get(K) - Method in interface me.a8kj.config.template.memory.DataMemory
-
Retrieves a raw object from memory by its key.
- get(K) - Method in class me.a8kj.config.template.memory.impl.GenericMapDataMemory
- get(K, Object) - Method in interface me.a8kj.config.template.memory.DataMemory
-
Retrieves an object from memory, returning a default value if the key is missing.
- get(MemoryDataType) - Method in class me.a8kj.config.template.memory.impl.MapDataMemory
- getBaseDirectory() - Method in interface me.a8kj.config.file.PathProvider
-
Retrieves the root directory from which all configuration paths are resolved.
- getBoolean(E, boolean) - Method in class me.a8kj.config.template.memory.impl.EnumDataMemory
- getBoolean(String, boolean) - Method in class me.a8kj.config.template.memory.impl.MapPairedDataMemory
- getBoolean(String, boolean) - Method in class me.a8kj.config.template.memory.impl.StringMapPairedDataMemory
- getBoolean(K, boolean) - Method in interface me.a8kj.config.template.memory.DataMemory
-
Retrieves a value as a boolean.
- getBoolean(K, boolean) - Method in class me.a8kj.config.template.memory.impl.GenericMapDataMemory
- getBoolean(MemoryDataType, boolean) - Method in class me.a8kj.config.template.memory.impl.MapDataMemory
- getComponent(String) - Method in class me.a8kj.config.template.memory.impl.VelocityDataMemory
-
A specialized version of transform that directly returns a Component.
- getComponent(String, Replacement...) - Method in class me.a8kj.config.template.memory.impl.VelocityDataMemory
-
Retrieves a value as a Kyori
Componentwith legacy color support. - getConfig(String) - Method in interface me.a8kj.config.ConfigAPI
-
Retrieves a specific configuration file from the registry using its unique key.
- getConfig(String) - Method in class me.a8kj.config.VelocityConfigAPI
-
Retrieves a specific configuration file by its unique key.
- getConfigRegistry() - Method in interface me.a8kj.config.ConfigAPI
-
Retrieves the central registry where all configuration files are stored.
- getConfigRegistry() - Method in class me.a8kj.config.VelocityConfigAPI
-
Retrieves the configuration registry instance.
- getDouble(E, double) - Method in class me.a8kj.config.template.memory.impl.EnumDataMemory
- getDouble(String, double) - Method in class me.a8kj.config.template.memory.impl.MapPairedDataMemory
- getDouble(String, double) - Method in class me.a8kj.config.template.memory.impl.StringMapPairedDataMemory
- getDouble(K, double) - Method in interface me.a8kj.config.template.memory.DataMemory
-
Retrieves a value as a double.
- getDouble(K, double) - Method in class me.a8kj.config.template.memory.impl.GenericMapDataMemory
- getDouble(MemoryDataType, double) - Method in class me.a8kj.config.template.memory.impl.MapDataMemory
- getEntity(String, Class<T>) - Method in interface me.a8kj.config.template.experimental.mapper.EntityAwareMemory
-
Retrieves and reconstructs an object of the specified type from the memory.
- getEventManager() - Method in interface me.a8kj.config.ConfigAPI
-
Retrieves the event manager responsible for handling library-specific events.
- getEventManager() - Method in class me.a8kj.config.VelocityConfigAPI
-
Retrieves the event manager instance.
- getInt(E, int) - Method in class me.a8kj.config.template.memory.impl.EnumDataMemory
- getInt(String, int) - Method in class me.a8kj.config.template.memory.impl.MapPairedDataMemory
- getInt(String, int) - Method in class me.a8kj.config.template.memory.impl.StringMapPairedDataMemory
- getInt(K, int) - Method in interface me.a8kj.config.template.memory.DataMemory
-
Retrieves a value as an integer.
- getInt(K, int) - Method in class me.a8kj.config.template.memory.impl.GenericMapDataMemory
- getInt(MemoryDataType, int) - Method in class me.a8kj.config.template.memory.impl.MapDataMemory
- getKeys(E, boolean) - Method in class me.a8kj.config.template.memory.impl.EnumDataMemory
- getKeys(String, boolean) - Method in class me.a8kj.config.template.memory.impl.MapPairedDataMemory
- getKeys(String, boolean) - Method in class me.a8kj.config.template.memory.impl.StringMapPairedDataMemory
- getKeys(K, boolean) - Method in interface me.a8kj.config.template.memory.DataMemory
-
Retrieves a set of keys under a specific path.
- getKeys(K, boolean) - Method in class me.a8kj.config.template.memory.impl.GenericMapDataMemory
- getKeys(MemoryDataType, boolean) - Method in class me.a8kj.config.template.memory.impl.MapDataMemory
- getMapperService() - Method in interface me.a8kj.config.template.experimental.mapper.EntityAwareMemory
-
Retrieves the mapper service responsible for converting entities to and from memory-compatible structures.
- getMapperService() - Method in class me.a8kj.config.template.experimental.mapper.EntityDataMemory
-
Retrieves the mapper service responsible for converting entities to and from memory-compatible structures.
- getName() - Method in interface me.a8kj.config.file.operation.ConfigOperation
-
Returns a human-readable name for the operation, primarily used for logging and debugging.
- getName() - Method in interface me.a8kj.config.file.properties.ConfigMeta
-
Retrieves the unique name of the configuration.
- getOptional(K) - Method in interface me.a8kj.config.template.memory.DataMemory
-
Wraps the retrieval of a key in an
Optional. - getProcessor() - Method in class me.a8kj.config.template.experimental.mapper.EntityDataMemory
-
Provides the
ReplacementProcessorassociated with this memory instance. - getProcessor() - Method in interface me.a8kj.config.template.memory.DataMemory
-
Provides the
ReplacementProcessorassociated with this memory instance. - getReader(File) - Method in class me.a8kj.config.file.BaseConfig
-
Provides a
Readerconfigured withUTF-8encoding. - getRelativePath() - Method in interface me.a8kj.config.file.properties.ConfigMeta
-
Retrieves the relative path where the configuration file is located.
- getString(E) - Method in class me.a8kj.config.template.memory.impl.EnumDataMemory
- getString(String) - Method in class me.a8kj.config.template.memory.impl.MapPairedDataMemory
- getString(String) - Method in class me.a8kj.config.template.memory.impl.StringMapPairedDataMemory
- getString(K) - Method in interface me.a8kj.config.template.memory.DataMemory
-
Retrieves a value as a
String. - getString(K) - Method in class me.a8kj.config.template.memory.impl.GenericMapDataMemory
- getString(K, String, Replacement...) - Method in interface me.a8kj.config.template.memory.DataMemory
-
Retrieves a string and applies dynamic replacements to it.
- getString(MemoryDataType) - Method in class me.a8kj.config.template.memory.impl.MapDataMemory
- getStringList(E) - Method in class me.a8kj.config.template.memory.impl.EnumDataMemory
- getStringList(String) - Method in class me.a8kj.config.template.memory.impl.MapPairedDataMemory
- getStringList(String) - Method in class me.a8kj.config.template.memory.impl.StringMapPairedDataMemory
- getStringList(K) - Method in interface me.a8kj.config.template.memory.DataMemory
-
Retrieves a list of strings from the specified key.
- getStringList(K) - Method in class me.a8kj.config.template.memory.impl.GenericMapDataMemory
- getStringList(K, Replacement...) - Method in interface me.a8kj.config.template.memory.DataMemory
-
Retrieves a string list and applies dynamic replacements to each entry.
- getStringList(MemoryDataType) - Method in class me.a8kj.config.template.memory.impl.MapDataMemory
- getValue(DataMemory<String>, String) - Method in enum class me.a8kj.config.template.memory.MemoryDataType
-
Executes the extraction strategy for the given memory and key.
- getVersion() - Method in interface me.a8kj.config.file.properties.ConfigMeta
-
Retrieves the version string of the configuration schema.
- getWriter(File) - Method in class me.a8kj.config.file.BaseConfig
-
Provides a
Writerconfigured withUTF-8encoding.
H
- hasEntry(String) - Method in class me.a8kj.config.template.registry.ConfigRegistry
-
Checks if a specific key is already registered.
- hasEntry(String) - Method in interface me.a8kj.util.Registry
-
Checks if the registry contains an entry for the specified key.
- hashCode() - Method in record class me.a8kj.config.file.impl.BasicConfigFile
-
Returns a hash code value for this object.
- hashCode() - Method in record class me.a8kj.config.template.replacement.impl.PlaceholderProcessor
-
Returns a hash code value for this object.
- hashCode() - Method in record class me.a8kj.config.template.replacement.Replacement
-
Returns a hash code value for this object.
- hashCode() - Method in record class me.a8kj.util.Pair
-
Returns a hash code value for this object.
- hybrid(PathProvider, PathProvider) - Static method in class me.a8kj.config.file.PathProviders
-
Creates a hybrid provider that attempts to use a primary directory if it exists and is writable, otherwise falls back to a secondary directory.
I
- INTEGER - Enum constant in enum class me.a8kj.config.template.memory.MemoryDataType
-
Handles retrieval of integer values with a default of 0.
- isLoggingEnabled() - Method in interface me.a8kj.config.file.properties.ConfigMeta
-
Determines whether logging is enabled for operations performed on this configuration.
J
- jarDir(Class<?>) - Static method in class me.a8kj.config.file.PathProviders
-
Creates a provider that points to the directory where the JAR file of the specified class is located.
- jarWithUserFallback(Class<?>) - Static method in class me.a8kj.config.file.PathProviders
-
Creates a hybrid provider that prioritizes the JAR's directory and falls back to the user's home directory if the JAR directory is not accessible/writable.
K
- key() - Method in class me.a8kj.config.template.memory.MemoryEntry
-
Returns the configuration key associated with this entry.
- key() - Method in record class me.a8kj.config.template.replacement.Replacement
-
Returns the value of the
keyrecord component. - key() - Method in record class me.a8kj.util.Pair
-
Returns the value of the
keyrecord component.
L
- load(ConfigAPI) - Static method in class me.a8kj.config.ConfigProvider
-
Initializes the provider with a specific API implementation.
- load(DataMemory<String>, String, Class<T>) - Method in class me.a8kj.config.template.experimental.mapper.BaseMapperOperator
-
Loads and reconstructs an entity from the provided
DataMemorybased on a specific path. - load(DataMemory<String>, String, Class<T>) - Method in interface me.a8kj.config.template.experimental.mapper.EntityLoader
-
Loads and reconstructs an entity from the provided
DataMemorybased on a specific path.
M
- MapDataMemory - Class in me.a8kj.config.template.memory.impl
-
A specialized implementation of
DataMemorythat usesMemoryDataTypeas its keys. - MapDataMemory() - Constructor for class me.a8kj.config.template.memory.impl.MapDataMemory
- MapPairedDataMemory - Class in me.a8kj.config.template.memory.impl
-
A implementation of
PairedDataMemoryspecialized forStringkeys. - MapPairedDataMemory() - Constructor for class me.a8kj.config.template.memory.impl.MapPairedDataMemory
- MapperOperatorContract - Interface in me.a8kj.config.template.experimental.mapper
-
A centralized contract for managing entity mapping operations within the configuration system.
- MapStructureUtils - Class in me.a8kj.util
-
Utility class for transforming between hierarchical and flat map structures.
- MapStructureUtils() - Constructor for class me.a8kj.util.MapStructureUtils
- me.a8kj.config - package me.a8kj.config
- me.a8kj.config.builder - package me.a8kj.config.builder
- me.a8kj.config.context - package me.a8kj.config.context
- me.a8kj.config.context.impl - package me.a8kj.config.context.impl
- me.a8kj.config.event - package me.a8kj.config.event
- me.a8kj.config.event.impl - package me.a8kj.config.event.impl
- me.a8kj.config.file - package me.a8kj.config.file
- me.a8kj.config.file.impl - package me.a8kj.config.file.impl
- me.a8kj.config.file.operation - package me.a8kj.config.file.operation
- me.a8kj.config.file.operation.impl - package me.a8kj.config.file.operation.impl
- me.a8kj.config.file.properties - package me.a8kj.config.file.properties
- me.a8kj.config.template.experimental.codec - package me.a8kj.config.template.experimental.codec
- me.a8kj.config.template.experimental.mapper - package me.a8kj.config.template.experimental.mapper
- me.a8kj.config.template.memory - package me.a8kj.config.template.memory
- me.a8kj.config.template.memory.impl - package me.a8kj.config.template.memory.impl
- me.a8kj.config.template.registry - package me.a8kj.config.template.registry
- me.a8kj.config.template.replacement - package me.a8kj.config.template.replacement
- me.a8kj.config.template.replacement.impl - package me.a8kj.config.template.replacement.impl
- me.a8kj.util - package me.a8kj.util
- memory() - Method in interface me.a8kj.config.file.ConfigFile
-
Retrieves the memory storage holding the configuration's loaded data.
- memory() - Method in record class me.a8kj.config.file.impl.BasicConfigFile
-
Returns the value of the
memoryrecord component. - memory(DataMemory<K>) - Method in class me.a8kj.config.builder.BasicConfigBuilder
-
Sets the memory storage implementation for holding the configuration data.
- memory(PairedDataMemory<K>) - Method in class me.a8kj.config.builder.PairedConfigBuilder
-
Sets the paired data memory implementation for managing key-value configuration data.
- memory(StringMapPairedDataMemory) - Method in class me.a8kj.config.builder.StringConfigBuilder
-
Allows overriding the default string memory implementation.
- MemoryDataType - Enum Class in me.a8kj.config.template.memory
-
Strategy-based enumeration for retrieving typed data from a
DataMemoryinstance. - MemoryEntry<T> - Class in me.a8kj.config.template.memory
-
Represents a predefined entry in the configuration memory.
- meta() - Method in interface me.a8kj.config.file.ConfigFile
-
Retrieves the metadata associated with this configuration.
- meta() - Method in record class me.a8kj.config.file.impl.BasicConfigFile
-
Returns the value of the
metarecord component. - meta(ConfigMeta) - Method in class me.a8kj.config.builder.BasicConfigBuilder
-
Sets the metadata for the configuration, such as name and relative path.
- meta(ConfigMeta) - Method in class me.a8kj.config.builder.PairedConfigBuilder
-
Sets the metadata for the configuration, containing identifying information and paths.
- meta(ConfigMeta) - Method in class me.a8kj.config.builder.StringConfigBuilder
-
Sets the configuration metadata including the name and path logic.
O
- OBJECT - Enum constant in enum class me.a8kj.config.template.memory.MemoryDataType
-
Handles retrieval of raw objects (Generic/Fallback).
- of(Class<T>) - Static method in class me.a8kj.config.builder.BasicConfigBuilder
-
Static factory method to initiate the builder with a specific key type.
- of(Class<T>) - Static method in class me.a8kj.config.builder.PairedConfigBuilder
-
Static factory method to initiate the paired builder with a specific key type.
- of(String, Object) - Static method in record class me.a8kj.config.template.replacement.Replacement
-
Creates a replacement from a raw object.
- of(String, Collection<String>) - Static method in record class me.a8kj.config.template.replacement.Replacement
-
Creates a replacement from a collection of strings.
- of(String, CRUDOperations<K>) - Static method in class me.a8kj.config.context.impl.BasicConfigExecutionContext
-
Static factory to create a context from a registered config key.
- of(String, MemoryDataType) - Static method in class me.a8kj.config.template.memory.MemoryEntry
-
Creates a new MemoryEntry instance.
- of(K, V) - Static method in record class me.a8kj.util.Pair
-
Creates a new immutable Pair instance.
- onPostCreate(ConfigFile<String>) - Method in class me.a8kj.config.AutoReadYamlSource
-
Invoked immediately after the configuration file has been created.
- onPostCreate(ConfigFile<String>) - Method in class me.a8kj.config.file.AutoReadBukkitConfig
-
Overrides the post-create hook to perform an automatic read operation.
- onPostCreate(ConfigFile<String>) - Method in class me.a8kj.config.file.BasicBukkitConfig
-
Dispatches a
ConfigCreateEventafter the configuration file is successfully created. - onPostCreate(ConfigFile<String>) - Method in class me.a8kj.config.file.impl.BasicVelocityConfig
-
Logic executed after the configuration file is created.
- onPostCreate(ConfigFile<K>) - Method in class me.a8kj.config.file.BaseConfig
-
Optional hook triggered after the configuration file has been successfully written to disk, either from a resource or as a new empty file.
- onPostDelete(ConfigFile<String>) - Method in class me.a8kj.config.file.BasicBukkitConfig
-
Dispatches a
ConfigDeleteEventafter the configuration file is successfully deleted. - onPostDelete(ConfigFile<String>) - Method in class me.a8kj.config.file.impl.BasicVelocityConfig
-
Logic executed after the configuration file is deleted.
- onPostDelete(ConfigFile<K>) - Method in class me.a8kj.config.file.BaseConfig
-
Optional hook triggered after the configuration file and its memory buffer have been successfully cleared and removed.
- onPreCreate(ConfigFile<K>) - Method in class me.a8kj.config.file.BaseConfig
-
Optional hook triggered immediately before the configuration file is created.
- onPreDelete(ConfigFile<K>) - Method in class me.a8kj.config.file.BaseConfig
-
Optional hook triggered immediately before the configuration file is deleted from disk.
- operations() - Method in interface me.a8kj.config.context.ConfigExecutionContext
-
Retrieves the operations handler (operator) used by this context.
- operations() - Method in class me.a8kj.config.context.impl.BasicConfigExecutionContext
P
- Pair<K,
V> - Record Class in me.a8kj.util -
A generic, immutable data carrier (Record) that holds two related objects.
- Pair(K, V) - Constructor for record class me.a8kj.util.Pair
-
Creates an instance of a
Pairrecord class. - PairedConfigBuilder<K> - Class in me.a8kj.config.builder
-
A specialized builder class for creating
ConfigFileinstances that utilizePairedDataMemory. - PairedDataMemory<K> - Interface in me.a8kj.config.template.memory.impl
-
An extension of
DataMemorythat supports advanced retrieval usingMemoryEntry. - PathProvider - Interface in me.a8kj.config.file
-
Provides a base directory context for resolving configuration file paths.
- PathProviders - Class in me.a8kj.config.file
-
A utility class providing common factory methods for creating
PathProviderinstances. - PathProviders() - Constructor for class me.a8kj.config.file.PathProviders
- percent() - Static method in record class me.a8kj.config.template.replacement.impl.PlaceholderProcessor
-
Creates a processor for percent-style placeholders:
%key%. - PlaceholderProcessor - Record Class in me.a8kj.config.template.replacement.impl
-
A highly customizable implementation of
ReplacementProcessorthat wraps keys with specified prefixes and suffixes. - PlaceholderProcessor(String, String) - Constructor for record class me.a8kj.config.template.replacement.impl.PlaceholderProcessor
-
Creates an instance of a
PlaceholderProcessorrecord class. - prefix() - Method in record class me.a8kj.config.template.replacement.impl.PlaceholderProcessor
-
Returns the value of the
prefixrecord component. - process(String, Replacement...) - Method in record class me.a8kj.config.template.replacement.impl.PlaceholderProcessor
-
Replaces all identified placeholders in the text with their corresponding values.
- process(String, Replacement...) - Method in interface me.a8kj.config.template.replacement.ReplacementProcessor
-
Processes a single string by applying the provided replacements.
- process(List<String>, Replacement...) - Method in interface me.a8kj.config.template.replacement.ReplacementProcessor
-
Processes a list of strings (e.g., a configuration's lore or multi-line message).
- provide() - Static method in class me.a8kj.config.ConfigProvider
-
Retrieves the currently loaded API implementation.
R
- read() - Method in class me.a8kj.config.file.BaseConfig
- read() - Method in class me.a8kj.config.file.BasicBukkitConfig
-
Creates a
ConfigOperationto read data from a YAML file into memory. - read() - Method in class me.a8kj.config.file.impl.BasicVelocityConfig
-
Provides a read operation to load Yaml data into memory.
- read() - Method in interface me.a8kj.config.file.operation.impl.ReadableConfig
-
Provides the operation logic for reading the configuration data.
- read() - Method in class me.a8kj.config.YamlSource
-
Reads the YAML file from disk and flattens it into the configuration memory.
- ReadableConfig<K> - Interface in me.a8kj.config.file.operation.impl
-
Defines the capability for a configuration to be read.
- register(String, ConfigFile<?>) - Method in class me.a8kj.config.template.registry.ConfigRegistry
-
Registers a configuration file with a unique identifying key.
- register(String, T) - Method in interface me.a8kj.util.Registry
-
Registers a value associated with a specific key.
- registerCodec(Class<T>, CodecAdapter<T, Map<String, Object>>) - Method in class me.a8kj.config.template.experimental.mapper.BaseMapperOperator
-
Registers a codec for a specific class type.
- registerCodec(Class<T>, CodecAdapter<T, Map<String, Object>>) - Method in interface me.a8kj.config.template.experimental.mapper.CodecRegistry
-
Registers a codec for a specific class type.
- registerListener(Listener) - Method in interface me.a8kj.config.ConfigAPI
-
Registers a listener to the event system.
- Registry<T> - Interface in me.a8kj.util
-
A generic contract for object registration and management.
- Replacement - Record Class in me.a8kj.config.template.replacement
-
A simple data carrier (Record) representing a placeholder and its replacement value.
- Replacement(String, String) - Constructor for record class me.a8kj.config.template.replacement.Replacement
-
Creates an instance of a
Replacementrecord class. - ReplacementProcessor - Interface in me.a8kj.config.template.replacement
-
Defines the contract for processing text and injecting dynamic data.
- resolve(String) - Method in interface me.a8kj.config.file.PathProvider
-
Resolves a relative path string against the base directory to produce a
Fileobject.
S
- save(DataMemory<String>, String, T) - Method in class me.a8kj.config.template.experimental.mapper.BaseMapperOperator
-
Serializes and saves an entity into the provided
DataMemoryunder a specific path. - save(DataMemory<String>, String, T) - Method in interface me.a8kj.config.template.experimental.mapper.EntitySaver
-
Serializes and saves an entity into the provided
DataMemoryunder a specific path. - serialize(T) - Method in class me.a8kj.config.template.experimental.codec.CodecAdapter
-
Serializes the given domain object into its encoded representation.
- serialize(T) - Method in interface me.a8kj.config.template.experimental.codec.Serializer
-
Serializes the provided domain object into its encoded form.
- Serializer<T,
S> - Interface in me.a8kj.config.template.experimental.codec -
Defines a functional contract for transforming domain objects into their serialized representations.
- set(E, Object) - Method in class me.a8kj.config.template.memory.impl.EnumDataMemory
- set(String, Object) - Method in class me.a8kj.config.template.memory.impl.MapPairedDataMemory
- set(String, Object) - Method in class me.a8kj.config.template.memory.impl.StringMapPairedDataMemory
- set(K, Object) - Method in interface me.a8kj.config.template.memory.DataMemory
-
Sets a value in the memory buffer for the specified key.
- set(K, Object) - Method in class me.a8kj.config.template.memory.impl.GenericMapDataMemory
- set(MemoryDataType, Object) - Method in class me.a8kj.config.template.memory.impl.MapDataMemory
- setEntity(String, T) - Method in interface me.a8kj.config.template.experimental.mapper.EntityAwareMemory
-
Persists an arbitrary object into the memory under the specified path.
- storage - Variable in class me.a8kj.config.template.memory.impl.EnumDataMemory
-
The internal storage map optimized for enum keys.
- storage - Variable in class me.a8kj.config.template.memory.impl.GenericMapDataMemory
-
The internal map used to store configuration values.
- STRING - Enum constant in enum class me.a8kj.config.template.memory.MemoryDataType
-
Handles retrieval of plain text.
- STRING_LIST - Enum constant in enum class me.a8kj.config.template.memory.MemoryDataType
-
Handles retrieval of string collections.
- StringConfigBuilder - Class in me.a8kj.config.builder
-
A simplified builder class specifically designed for configurations that use
Stringkeys. - StringMapPairedDataMemory - Class in me.a8kj.config.template.memory.impl
-
A standard string-keyed implementation of
PairedDataMemory. - StringMapPairedDataMemory() - Constructor for class me.a8kj.config.template.memory.impl.StringMapPairedDataMemory
- suffix() - Method in record class me.a8kj.config.template.replacement.impl.PlaceholderProcessor
-
Returns the value of the
suffixrecord component.
T
- tempDir() - Static method in class me.a8kj.config.file.PathProviders
-
Creates a provider that points to the system's default temporary directory.
- toString() - Method in record class me.a8kj.config.file.impl.BasicConfigFile
-
Returns a string representation of this record class.
- toString() - Method in record class me.a8kj.config.template.replacement.impl.PlaceholderProcessor
-
Returns a string representation of this record class.
- toString() - Method in record class me.a8kj.config.template.replacement.Replacement
-
Returns a string representation of this record class.
- toString() - Method in record class me.a8kj.util.Pair
-
Returns a string representation of this record class.
- transform(String, Replacement...) - Method in interface me.a8kj.config.template.memory.DataMemory
-
Transforms a given text by applying the provided replacements using the internal processor.
- transform(String, Replacement...) - Method in class me.a8kj.config.template.memory.impl.EnumDataMemory
-
Transforms the input text by processing provided replacements through the configured
ReplacementProcessor. - transform(String, Replacement...) - Method in class me.a8kj.config.template.memory.impl.GenericMapDataMemory
-
Applies text transformations using the internal
ReplacementProcessor. - transform(String, Replacement...) - Method in class me.a8kj.config.template.memory.impl.MapDataMemory
-
Transforms text by applying placeholders using the internal
ReplacementProcessor. - transform(String, Replacement...) - Method in class me.a8kj.config.template.memory.impl.MapPairedDataMemory
-
Processes placeholders within the given text using the
ReplacementProcessor. - transform(String, Replacement...) - Method in class me.a8kj.config.template.memory.impl.StringMapPairedDataMemory
-
Processes placeholders in the provided text using the internal
ReplacementProcessor. - type() - Method in class me.a8kj.config.template.memory.MemoryEntry
-
Returns the
MemoryDataTypeof this entry.
U
- unflatten(Map<String, Object>) - Static method in class me.a8kj.util.MapStructureUtils
-
Reconstructs a nested
Mapfrom a flat map with dot-separated keys. - unflattenUnderPath(String, DataMemory<String>) - Static method in class me.a8kj.util.MapStructureUtils
-
Extracts a nested map from a DataMemory under a specific path.
- unregister(String) - Method in class me.a8kj.config.template.registry.ConfigRegistry
-
Removes a configuration from the registry.
- unregister(String) - Method in interface me.a8kj.util.Registry
-
Removes an entry from the registry using its key.
- unregisterListener(Listener) - Method in interface me.a8kj.config.ConfigAPI
-
Unregisters a previously registered listener from the event system.
- UpdatableConfig<K> - Interface in me.a8kj.config.file.operation.impl
-
Defines the capability for a configuration to be updated or saved.
- update() - Method in class me.a8kj.config.file.BaseConfig
- update() - Method in class me.a8kj.config.file.BasicBukkitConfig
-
Creates a
ConfigOperationto save the current memory state back to a YAML file. - update() - Method in class me.a8kj.config.file.impl.BasicVelocityConfig
-
Provides an update operation to save memory state back to Yaml file.
- update() - Method in interface me.a8kj.config.file.operation.impl.UpdatableConfig
-
Provides the operation logic for updating (saving) the configuration data.
- update() - Method in class me.a8kj.config.YamlSource
-
Synchronizes the in-memory data with the physical file using a merge strategy.
- userDir() - Static method in class me.a8kj.config.file.PathProviders
-
Creates a provider that points to the current user's home directory.
V
- value() - Method in record class me.a8kj.config.template.replacement.Replacement
-
Returns the value of the
valuerecord component. - value() - Method in record class me.a8kj.util.Pair
-
Returns the value of the
valuerecord component. - valueOf(String) - Static method in enum class me.a8kj.config.template.memory.MemoryDataType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class me.a8kj.config.template.memory.MemoryDataType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VelocityConfigAPI - Class in me.a8kj.config
-
Implementation of the
ConfigAPIspecifically for the Velocity Proxy platform. - VelocityConfigAPI() - Constructor for class me.a8kj.config.VelocityConfigAPI
- VelocityDataMemory - Class in me.a8kj.config.template.memory.impl
-
Velocity-specific implementation of
GenericMapDataMemory. - VelocityDataMemory() - Constructor for class me.a8kj.config.template.memory.impl.VelocityDataMemory
Y
- YamlSource - Class in me.a8kj.config
-
A robust YAML implementation of
BaseConfigthat supports hierarchical data structures and persistent merging. - YamlSource() - Constructor for class me.a8kj.config.YamlSource
-
Initializes the YAML source with standard block-style formatting.
All Classes and Interfaces|All Packages