Index (6b6t Commons API)

A B C D E F G H I J L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

accept(Connection) - Method in interface net.blockhost.commons.database.core.SQLManager.ConnectionConsumer: Performs an operation using the given connection.
accept(T) - Method in interface net.blockhost.commons.core.io.IOConsumer: Performs this operation on the given argument.
afterMigration(MigrationExecutor.MigrationCallback) - Method in class net.blockhost.commons.config.migration.MigrationExecutor: Sets a callback to be invoked after each successful migration.
afterMigration(MigrationExecutor.MigrationCallback) - Method in class net.blockhost.commons.config.migration.ConfigMigrator.Builder: Sets a callback to be invoked after each successful migration.
apply(Connection) - Method in interface net.blockhost.commons.database.core.SQLManager.ConnectionFunction: Performs an operation using the given connection and returns a result.
AtomicFileWriter - Class in net.blockhost.commons.core.io: Utility class for writing files atomically using a write-to-temp-then-rename strategy.
autoReconnect(boolean) - Method in class net.blockhost.commons.database.core.HikariDataSourceBuilder: Enables or disables auto-reconnect.

B

backupSuffix(String) - Method in class net.blockhost.commons.config.migration.ConfigMigrator.Builder: Sets the backup file suffix.
beforeMigration(Consumer) - Method in class net.blockhost.commons.config.migration.MigrationExecutor: Sets a callback to be invoked before each migration.
beforeMigration(Consumer) - Method in class net.blockhost.commons.config.migration.ConfigMigrator.Builder: Sets a callback to be invoked before each migration.
build() - Method in class net.blockhost.commons.config.migration.ConfigMigrator.Builder: Builds the ConfigMigrator.
build() - Method in class net.blockhost.commons.database.core.DatabaseCredentials.DatabaseCredentialsBuilder
build() - Method in class net.blockhost.commons.database.core.HikariDataSourceBuilder: Builds the HikariDataSource with the configured settings.
build() - Method in class net.blockhost.commons.database.core.SQLManager.Builder: Builds the SQLManager instance.
build() - Method in class net.blockhost.commons.database.redis.RedisManager.Builder: Builds the RedisManager instance.
build(int) - Method in class net.blockhost.commons.config.migration.MigrationResult.Builder: Builds a successful result.
builder() - Static method in class net.blockhost.commons.config.migration.ConfigMigrator: Creates a new migrator builder.
builder() - Static method in class net.blockhost.commons.database.core.DatabaseCredentials
builder() - Static method in class net.blockhost.commons.database.redis.RedisManager: Creates a new builder for RedisManager.
builder(int, Map) - Static method in interface net.blockhost.commons.config.migration.MigrationResult: Creates a new result builder.

C

cachePreparedStatements(boolean) - Method in class net.blockhost.commons.database.core.HikariDataSourceBuilder: Enables or disables prepared statement caching.
canMigrate(int, int) - Method in class net.blockhost.commons.config.migration.ConfigMigrator: Checks if all migrations are available for the given version range.
canMigrate(int, int) - Method in class net.blockhost.commons.config.migration.MigrationExecutor: Checks if migrations can be executed for the given version range.
cause() - Method in record class net.blockhost.commons.config.migration.MigrationResult.Failure: Returns the value of the cause record component.
clear() - Method in class net.blockhost.commons.config.migration.MigrationRegistry: Clears all registered migrations.
clearProperties() - Method in class net.blockhost.commons.database.core.DatabaseCredentials.DatabaseCredentialsBuilder
command() - Method in record class net.blockhost.commons.commands.help.HelpFormatter.CommandEntry: Returns the value of the command record component.
CommandDescription - Annotation Interface in net.blockhost.commons.commands.help
CommandEntry(String, String) - Constructor for record class net.blockhost.commons.commands.help.HelpFormatter.CommandEntry: Creates an instance of a CommandEntry record class.
commandFormat - Variable in class net.blockhost.commons.commands.help.HelpConfig
completeStep(Migration) - Method in class net.blockhost.commons.config.migration.MigrationResult.Builder: Records the completion of a migration step.
config(PooledDatabaseConfig) - Method in class net.blockhost.commons.database.core.SQLManager.Builder: Sets all database settings from a pooled database configuration.
config(RedisConfig) - Method in class net.blockhost.commons.database.redis.RedisManager.Builder: Sets the Redis configuration.
ConfigLoader - Class in net.blockhost.commons.config: Utility class for loading and saving configuration files using ConfigLib.
ConfigMigrator - Class in net.blockhost.commons.config.migration: High-level API for migrating configuration files.
ConfigMigrator.Builder - Class in net.blockhost.commons.config.migration: Builder for creating ConfigMigrator instances.
ConfigurationHolder<T> - Class in net.blockhost.commons.config: A holder for configuration instances that supports dependency injection and reloading.
ConfigurationHolder(Supplier) - Constructor for class net.blockhost.commons.config.ConfigurationHolder: Protected constructor for subclasses.
ConfigurationHolder(Supplier, Path, Class) - Constructor for class net.blockhost.commons.config.ConfigurationHolder: Protected constructor for subclasses with save support.
connect() - Method in class net.blockhost.commons.database.core.SQLManager: Connects to the database and initializes the connection pool.
connect() - Method in class net.blockhost.commons.database.redis.RedisManager: Connects to Redis and initializes the connection pool.
connectionTimeout() - Method in class net.blockhost.commons.database.core.DatabaseCredentials
connectionTimeout(Duration) - Method in class net.blockhost.commons.database.core.DatabaseCredentials.DatabaseCredentialsBuilder: Sets the connection timeout duration.
connectionTimeout(Duration) - Method in class net.blockhost.commons.database.core.HikariDataSourceBuilder: Sets the maximum time to wait for a connection from the pool.
connectionTimeoutMs() - Method in class net.blockhost.commons.database.redis.RedisConfig
connectionTimeoutSeconds() - Method in class net.blockhost.commons.database.mariadb.MariaDbConfig
connectionTimeoutSeconds() - Method in class net.blockhost.commons.database.postgres.PostgresConfig
connectionTimeoutSeconds(int) - Method in class net.blockhost.commons.database.core.DatabaseCredentials.DatabaseCredentialsBuilder: Sets the connection timeout in seconds.
contains(int) - Method in class net.blockhost.commons.config.migration.MigrationRegistry: Checks if a migration exists for the specified target version.
convert(String) - Static method in class net.blockhost.commons.message.MiniMessageConverter: Converts a string containing legacy color codes to MiniMessage format.
copyData() - Method in class net.blockhost.commons.config.migration.MigrationContext: Creates a copy of the current data.
create() - Static method in class net.blockhost.commons.config.migration.MigrationRegistry: Creates a new thread-safe migration registry.
create(Function) - Static method in class net.blockhost.commons.message.MessageService: Creates a new message service with the specified message provider.
create(MigrationRegistry) - Static method in class net.blockhost.commons.config.migration.MigrationExecutor: Creates a new migration executor with the specified registry.
create(DatabaseCredentials) - Static method in class net.blockhost.commons.database.core.HikariDataSourceBuilder: Creates a new builder with the specified credentials.
create(PooledDatabaseConfig) - Static method in class net.blockhost.commons.database.core.SQLManager: Creates a new builder for SQLManager using a pooled database configuration.
createBackups(boolean) - Method in class net.blockhost.commons.config.migration.ConfigMigrator.Builder: Enables or disables backup creation.
createNonConcurrent() - Static method in class net.blockhost.commons.config.migration.MigrationRegistry: Creates a new non-thread-safe migration registry.
currentVersion() - Method in class net.blockhost.commons.config.migration.MigrationContext: Returns the version the data is currently at.

D

data() - Method in class net.blockhost.commons.config.migration.MigrationContext: Returns the mutable map containing the YAML data.
data() - Method in interface net.blockhost.commons.config.migration.MigrationResult: Returns the migrated data.
data() - Method in record class net.blockhost.commons.config.migration.MigrationResult.Failure: Returns the value of the data record component.
data() - Method in record class net.blockhost.commons.config.migration.MigrationResult.Success: Returns the value of the data record component.
database() - Method in class net.blockhost.commons.database.mariadb.MariaDbConfig
database() - Method in class net.blockhost.commons.database.postgres.PostgresConfig
database() - Method in class net.blockhost.commons.database.redis.RedisConfig
DatabaseCredentials - Class in net.blockhost.commons.database.core: Immutable holder for database connection credentials and configuration.
DatabaseCredentials.DatabaseCredentialsBuilder - Class in net.blockhost.commons.database.core: Custom builder with validation.
defaultPropertiesBuilder() - Static method in class net.blockhost.commons.config.ConfigLoader: Creates a default properties builder with common settings.
defaultPropertiesBuilder(String) - Static method in class net.blockhost.commons.config.ConfigLoader: Creates a default properties builder with environment variable resolution.
description() - Method in class net.blockhost.commons.commands.help.HelpCommandWrapper
description() - Method in record class net.blockhost.commons.commands.help.HelpFormatter.CommandEntry: Returns the value of the description record component.
description() - Method in interface net.blockhost.commons.config.migration.Migration: Returns a human-readable description of what this migration does.
description() - Method in record class net.blockhost.commons.config.migration.MigrationResult.MigrationStep: Returns the value of the description record component.
deserialize(String) - Method in class net.blockhost.commons.message.MiniMessageConfigSerializer: Deserializes a config value, converting legacy color codes to MiniMessage.
DRIVER_CLASS - Static variable in class net.blockhost.commons.database.mariadb.MariaDbConfig: MariaDB JDBC driver class name.
DRIVER_CLASS - Static variable in class net.blockhost.commons.database.postgres.PostgresConfig: PostgreSQL JDBC driver class name.
driverClassName() - Method in class net.blockhost.commons.database.core.DatabaseCredentials
driverClassName(String) - Method in class net.blockhost.commons.database.core.DatabaseCredentials.DatabaseCredentialsBuilder: Sets the JDBC driver class name.
dryRun(boolean) - Method in class net.blockhost.commons.config.migration.MigrationExecutor: Enables or disables dry run mode.
duration() - Method in interface net.blockhost.commons.config.migration.MigrationResult: Returns the total duration of the migration operation.
duration() - Method in record class net.blockhost.commons.config.migration.MigrationResult.Failure: Returns the value of the duration record component.
duration() - Method in record class net.blockhost.commons.config.migration.MigrationResult.MigrationStep: Returns the value of the duration record component.
duration() - Method in record class net.blockhost.commons.config.migration.MigrationResult.Success: Returns the value of the duration record component.

E

envPrefix(String) - Method in class net.blockhost.commons.config.migration.ConfigMigrator.Builder: Sets the environment variable prefix for config value resolution.
equals(Object) - Method in record class net.blockhost.commons.commands.help.HelpFormatter.CommandEntry: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.blockhost.commons.config.migration.MigrationResult.Failure: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.blockhost.commons.config.migration.MigrationResult.MigrationStep: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class net.blockhost.commons.config.migration.MigrationResult.Success: Indicates whether some other object is "equal to" this one.
error() - Method in interface net.blockhost.commons.config.migration.MigrationResult: Returns the error if the migration failed.
error() - Method in record class net.blockhost.commons.config.migration.MigrationResult.Failure
error() - Method in record class net.blockhost.commons.config.migration.MigrationResult.Success
execute(Path, Map, int, int) - Method in class net.blockhost.commons.config.migration.MigrationExecutor: Executes migrations on the provided data.
execute(Map, int, int) - Method in class net.blockhost.commons.config.migration.MigrationExecutor: Executes migrations on in-memory data without a file path.
extractVersion(Map) - Static method in class net.blockhost.commons.config.migration.RawYamlLoader: Extracts the version field from YAML data.

F

fail(int, MigrationException) - Method in class net.blockhost.commons.config.migration.MigrationResult.Builder: Builds a failed result.
failure(int, int, List, Duration, Map, MigrationException) - Static method in interface net.blockhost.commons.config.migration.MigrationResult: Creates a failed migration result.
Failure(int, int, List, Duration, Map, MigrationException) - Constructor for record class net.blockhost.commons.config.migration.MigrationResult.Failure: Creates an instance of a Failure record class.
filePath() - Method in class net.blockhost.commons.config.migration.MigrationContext: Returns the path to the configuration file being migrated.
findMissingMigrations(int, int) - Method in class net.blockhost.commons.config.migration.MigrationRegistry: Validates that all migrations needed to go from one version to another exist.
footer - Variable in class net.blockhost.commons.commands.help.HelpConfig
format(Duration) - Static method in class net.blockhost.commons.core.TimeFormatter: Formats a Duration into a human-readable string.
formatCompact(long) - Static method in class net.blockhost.commons.core.TimeFormatter: Formats a duration in seconds into a compact MM:SS or HH:MM:SS format.
formatCompact(Duration) - Static method in class net.blockhost.commons.core.TimeFormatter: Formats a Duration into a compact MM:SS or HH:MM:SS format.
formatLong(long) - Static method in class net.blockhost.commons.core.TimeFormatter: Formats a duration with full unit names.
formatLong(Duration) - Static method in class net.blockhost.commons.core.TimeFormatter: Formats a Duration with full unit names.
formatMillis(long) - Static method in class net.blockhost.commons.core.TimeFormatter: Formats a duration in milliseconds into a human-readable string.
formatSeconds(long) - Static method in class net.blockhost.commons.core.TimeFormatter: Formats a duration in seconds into a human-readable string.
from(Migration, Instant, Instant) - Static method in record class net.blockhost.commons.config.migration.MigrationResult.MigrationStep: Creates a migration step from a migration and timing information.
fromVersion() - Method in record class net.blockhost.commons.config.migration.MigrationResult.Failure: Returns the value of the fromVersion record component.
fromVersion() - Method in interface net.blockhost.commons.config.migration.MigrationResult: Returns the version the data was at before migration.
fromVersion() - Method in record class net.blockhost.commons.config.migration.MigrationResult.MigrationStep: Returns the value of the fromVersion record component.
fromVersion() - Method in record class net.blockhost.commons.config.migration.MigrationResult.Success: Returns the value of the fromVersion record component.

G

get() - Method in class net.blockhost.commons.config.ConfigurationHolder: Gets the current configuration instance.
get(int) - Method in class net.blockhost.commons.config.migration.MigrationRegistry: Gets the migration for a specific target version.
get(String) - Method in class net.blockhost.commons.message.MessageService: Gets a message by key and parses it.
get(String, Class) - Method in class net.blockhost.commons.config.migration.MigrationContext: Gets a value from the data map with type casting.
get(String, Map) - Method in class net.blockhost.commons.message.MessageService: Gets a message by key and parses it with placeholder replacements.
get(String, TagResolver...) - Method in class net.blockhost.commons.message.MessageService: Gets a message by key and parses it with tag resolvers.
getAllMigrations() - Method in class net.blockhost.commons.config.migration.MigrationRegistry: Returns all registered migrations in version order.
getAllVersions() - Method in class net.blockhost.commons.config.migration.MigrationRegistry: Returns all registered target versions in ascending order.
getBoolean(String) - Method in class net.blockhost.commons.config.migration.MigrationContext: Gets a boolean value from the data map.
getConfig() - Method in class net.blockhost.commons.database.redis.RedisManager: Gets the current Redis configuration.
getConfigPath() - Method in class net.blockhost.commons.config.ConfigurationHolder: Gets the path where this configuration is stored.
getConnection() - Method in class net.blockhost.commons.database.core.SQLManager: Gets a connection from the pool.
getConnection() - Method in class net.blockhost.commons.database.redis.RedisManager: Gets a Jedis connection from the pool.
getCredentials() - Method in class net.blockhost.commons.database.core.SQLManager: Gets the current database credentials.
getHighestVersion() - Method in class net.blockhost.commons.config.migration.MigrationRegistry: Gets the highest registered target version.
getInt(String) - Method in class net.blockhost.commons.config.migration.MigrationContext: Gets an integer value from the data map.
getList(String) - Method in class net.blockhost.commons.config.migration.MigrationContext: Gets a list value from the data map.
getLowestVersion() - Method in class net.blockhost.commons.config.migration.MigrationRegistry: Gets the lowest registered target version.
getMigrationsInRange(int, int) - Method in class net.blockhost.commons.config.migration.MigrationRegistry: Gets all migrations needed to migrate from one version to another.
getNestedMap(String) - Method in class net.blockhost.commons.config.migration.MigrationContext: Gets a nested map from the data.
getNestedValue(String, String, Class) - Method in class net.blockhost.commons.config.migration.MigrationContext: Gets a value from a nested map.
getOrCreateNestedMap(String) - Method in class net.blockhost.commons.config.migration.MigrationContext: Gets or creates a nested map in the data.
getString(String) - Method in class net.blockhost.commons.config.migration.MigrationContext: Gets a string value from the data map.
getVersion(Path) - Method in class net.blockhost.commons.config.migration.ConfigMigrator: Gets the current version of a configuration file.

H

hasCompleteMigrationChain(int, int) - Method in class net.blockhost.commons.config.migration.MigrationRegistry: Checks if the registry has a complete migration chain between two versions.
hashCode() - Method in record class net.blockhost.commons.commands.help.HelpFormatter.CommandEntry: Returns a hash code value for this object.
hashCode() - Method in record class net.blockhost.commons.config.migration.MigrationResult.Failure: Returns a hash code value for this object.
hashCode() - Method in record class net.blockhost.commons.config.migration.MigrationResult.MigrationStep: Returns a hash code value for this object.
hashCode() - Method in record class net.blockhost.commons.config.migration.MigrationResult.Success: Returns a hash code value for this object.
header - Variable in class net.blockhost.commons.commands.help.HelpConfig
HelpCommandWrapper<S> - Class in net.blockhost.commons.commands.help
HelpCommandWrapper(Command, Function, boolean) - Constructor for class net.blockhost.commons.commands.help.HelpCommandWrapper
HelpConfig - Class in net.blockhost.commons.commands.help: Configuration for command help message formatting.
HelpConfig() - Constructor for class net.blockhost.commons.commands.help.HelpConfig
HelpFormatter - Class in net.blockhost.commons.commands.help: Formats and sends help messages for commands.
HelpFormatter(HelpConfig) - Constructor for class net.blockhost.commons.commands.help.HelpFormatter: Creates a new help formatter with the given configuration.
HelpFormatter.CommandEntry - Record Class in net.blockhost.commons.commands.help: Represents a command entry in the help listing.
HelpInjector - Class in net.blockhost.commons.commands.help
HikariDataSourceBuilder - Class in net.blockhost.commons.database.core: Builder for creating HikariCP connection pool data sources.
host() - Method in class net.blockhost.commons.database.mariadb.MariaDbConfig
host() - Method in class net.blockhost.commons.database.postgres.PostgresConfig
host() - Method in class net.blockhost.commons.database.redis.RedisConfig

I

idleTimeout(Duration) - Method in class net.blockhost.commons.database.core.HikariDataSourceBuilder: Sets the maximum time a connection can be idle before being retired.
immutableCopy() - Method in class net.blockhost.commons.config.migration.MigrationRegistry: Creates an immutable copy of this registry.
infoLogger(Consumer) - Method in class net.blockhost.commons.database.core.SQLManager.Builder: Sets a custom info log consumer.
infoLogger(Consumer) - Method in class net.blockhost.commons.database.redis.RedisManager.Builder: Sets a custom info log consumer.
invalidVersionRange(int, int) - Static method in exception class net.blockhost.commons.config.migration.MigrationException: Creates a migration exception indicating an invalid version range.
IOConsumer<T> - Interface in net.blockhost.commons.core.io: A functional interface like Consumer that allows checked IOExceptions.
isConnected() - Method in class net.blockhost.commons.database.core.SQLManager: Checks if the manager is currently connected to the database.
isConnected() - Method in class net.blockhost.commons.database.redis.RedisManager: Checks if the manager is currently connected to Redis.
isEmpty() - Method in class net.blockhost.commons.config.migration.MigrationRegistry: Checks if the registry is empty.
isSuccess() - Method in record class net.blockhost.commons.config.migration.MigrationResult.Failure
isSuccess() - Method in interface net.blockhost.commons.config.migration.MigrationResult: Returns whether the migration completed successfully.
isSuccess() - Method in record class net.blockhost.commons.config.migration.MigrationResult.Success

J

jdbcUrl() - Method in class net.blockhost.commons.database.core.DatabaseCredentials
jdbcUrl() - Method in class net.blockhost.commons.database.mariadb.MariaDbConfig: Constructs the JDBC URL for MariaDB connections.
jdbcUrl() - Method in class net.blockhost.commons.database.postgres.PostgresConfig: Constructs the JDBC URL for PostgreSQL connections.
jdbcUrl(String) - Method in class net.blockhost.commons.database.core.DatabaseCredentials.DatabaseCredentialsBuilder: Sets the JDBC URL for the database connection.

L

load(InputStream) - Static method in class net.blockhost.commons.config.migration.RawYamlLoader: Loads YAML content from an input stream.
load(Reader) - Static method in class net.blockhost.commons.config.migration.RawYamlLoader: Loads YAML content from a reader.
load(Path) - Static method in class net.blockhost.commons.config.migration.RawYamlLoader: Loads YAML content from a file path.
load(Path, Class, YamlConfigurationProperties) - Static method in class net.blockhost.commons.config.ConfigLoader: Loads a configuration from an existing file.
loadFromString(String) - Static method in class net.blockhost.commons.config.migration.RawYamlLoader: Loads YAML content from a string.
loadOrCreate(Path, Class, YamlConfigurationProperties) - Static method in class net.blockhost.commons.config.ConfigLoader: Loads a configuration from the specified path, or creates it with default values if it doesn't exist.
logger(Logger) - Method in class net.blockhost.commons.database.core.SQLManager.Builder: Sets the logger for database messages.
logger(Logger) - Method in class net.blockhost.commons.database.redis.RedisManager.Builder: Sets the logger for Redis messages.

M

MariaDbConfig - Class in net.blockhost.commons.database.mariadb: ConfigLib-compatible MariaDB database configuration class.
MariaDbConfig() - Constructor for class net.blockhost.commons.database.mariadb.MariaDbConfig
MariaDbConfig(String, int, String, String, String, int, int, int) - Constructor for class net.blockhost.commons.database.mariadb.MariaDbConfig
maxIdle() - Method in class net.blockhost.commons.database.redis.RedisConfig
maximumPoolSize(int) - Method in class net.blockhost.commons.database.core.HikariDataSourceBuilder: Sets the maximum size of the connection pool.
maxLifetime(Duration) - Method in class net.blockhost.commons.database.core.HikariDataSourceBuilder: Sets the maximum lifetime of a connection in the pool.
maxPoolSize() - Method in interface net.blockhost.commons.database.core.PooledDatabaseConfig: Gets the maximum number of connections in the pool.
maxPoolSize() - Method in class net.blockhost.commons.database.mariadb.MariaDbConfig
maxPoolSize() - Method in class net.blockhost.commons.database.postgres.PostgresConfig
maxPoolSize() - Method in class net.blockhost.commons.database.redis.RedisConfig
MessageService - Class in net.blockhost.commons.message: Service for handling MiniMessage-based message formatting and sending.
migrate(Path, int) - Method in class net.blockhost.commons.config.migration.ConfigMigrator: Migrates a configuration file to the target version.
migrate(MigrationContext) - Method in interface net.blockhost.commons.config.migration.Migration: Performs the migration on the provided context.
migrate(MigrationContext) - Method in interface net.blockhost.commons.config.migration.Migration.MigrationAction: Performs the migration.
migrateAndLoad(Path, Class, int) - Method in class net.blockhost.commons.config.migration.ConfigMigrator: Migrates a configuration file to the target version and loads it.
migrateAndLoad(Path, Class, int, YamlConfigurationProperties) - Method in class net.blockhost.commons.config.migration.ConfigMigrator: Migrates a configuration file to the target version and loads it with custom properties.
migrateData(Map, int, int) - Method in class net.blockhost.commons.config.migration.ConfigMigrator: Migrates in-memory data without file I/O.
Migration - Interface in net.blockhost.commons.config.migration: Represents a single configuration migration step from one version to the next.
Migration.MigrationAction - Interface in net.blockhost.commons.config.migration: Functional interface for migration actions.
MigrationContext - Class in net.blockhost.commons.config.migration: Holds the state and data for a configuration migration.
MigrationException - Exception Class in net.blockhost.commons.config.migration: Exception thrown when a configuration migration fails.
MigrationException(String) - Constructor for exception class net.blockhost.commons.config.migration.MigrationException: Creates a new migration exception with the specified message.
MigrationException(String, Throwable) - Constructor for exception class net.blockhost.commons.config.migration.MigrationException: Creates a new migration exception with the specified message and cause.
MigrationException(Throwable) - Constructor for exception class net.blockhost.commons.config.migration.MigrationException: Creates a new migration exception with the specified cause.
MigrationExecutor - Class in net.blockhost.commons.config.migration: Executes configuration migrations sequentially by version.
MigrationExecutor.MigrationCallback - Interface in net.blockhost.commons.config.migration: Callback interface for post-migration notifications.
migrationFailed(int, Throwable) - Static method in exception class net.blockhost.commons.config.migration.MigrationException: Creates a migration exception indicating a migration failure at a specific version.
MigrationRegistry - Class in net.blockhost.commons.config.migration: Registry for managing configuration migrations indexed by version.
MigrationResult - Interface in net.blockhost.commons.config.migration: Encapsulates the outcome of a configuration migration operation.
MigrationResult.Builder - Class in net.blockhost.commons.config.migration: Builder for creating migration results incrementally.
MigrationResult.Failure - Record Class in net.blockhost.commons.config.migration: Represents a failed migration result.
MigrationResult.MigrationStep - Record Class in net.blockhost.commons.config.migration: Represents a single migration step that was applied.
MigrationResult.Success - Record Class in net.blockhost.commons.config.migration: Represents a successful migration result.
MigrationStep(int, int, String, Duration) - Constructor for record class net.blockhost.commons.config.migration.MigrationResult.MigrationStep: Creates an instance of a MigrationStep record class.
MINI_MESSAGE() - Static method in class net.blockhost.commons.message.MessageService
minIdle() - Method in interface net.blockhost.commons.database.core.PooledDatabaseConfig: Gets the minimum number of idle connections in the pool.
minIdle() - Method in class net.blockhost.commons.database.mariadb.MariaDbConfig
minIdle() - Method in class net.blockhost.commons.database.postgres.PostgresConfig
minIdle() - Method in class net.blockhost.commons.database.redis.RedisConfig
miniMessage() - Static method in class net.blockhost.commons.message.MessageService: Returns the shared MiniMessage instance.
MiniMessageConfigSerializer - Class in net.blockhost.commons.message: ConfigLib serializer that converts legacy color codes to MiniMessage format.
MiniMessageConfigSerializer() - Constructor for class net.blockhost.commons.message.MiniMessageConfigSerializer: Creates a new MiniMessage serializer.
MiniMessageConverter - Class in net.blockhost.commons.message: Utility class for converting legacy Minecraft color codes to MiniMessage format.
minimumIdle(int) - Method in class net.blockhost.commons.database.core.HikariDataSourceBuilder: Sets the minimum number of idle connections in the pool.
missingMigration(int, int) - Static method in exception class net.blockhost.commons.config.migration.MigrationException: Creates a migration exception indicating a missing migration.
moveFromNested(String, String, String) - Method in class net.blockhost.commons.config.migration.MigrationContext: Moves a value from a nested map to the root map.
moveToNested(String, String, String) - Method in class net.blockhost.commons.config.migration.MigrationContext: Moves a value from one location to a nested map.

N

needsMigration(Path, int) - Method in class net.blockhost.commons.config.migration.ConfigMigrator

Checks if migrations are needed for a configuration file.

net.blockhost.commons.commands.help - package net.blockhost.commons.commands.help

Help system for command documentation.

net.blockhost.commons.config - package net.blockhost.commons.config

Quick Start

Basic Configuration

Define your configuration class using ConfigLib annotations:

@Configuration
public class MyPluginConfig {
    @Comment("The server host address")
    private String host = "localhost";

    @Comment("The server port")
    private int port = 3306;

    @Comment("Database settings")
    private DatabaseSettings database = new DatabaseSettings();
}

Load your configuration:

Path configPath = plugin.getDataFolder().toPath().resolve("config.yml");
var properties = ConfigLoader.defaultPropertiesBuilder().build();
MyPluginConfig config = ConfigLoader.loadOrCreate(configPath, MyPluginConfig.class, properties);

Versioned Configuration with Migration

For configurations that may change over time, use VersionAwareConfiguration:

net.blockhost.commons.config.migration - package net.blockhost.commons.config.migration

Configuration migration framework for versioned YAML configurations.

net.blockhost.commons.core - package net.blockhost.commons.core

net.blockhost.commons.core.io - package net.blockhost.commons.core.io

net.blockhost.commons.database.core - package net.blockhost.commons.database.core

Core database utilities for 6b6t plugins.

net.blockhost.commons.database.mariadb - package net.blockhost.commons.database.mariadb

MariaDB database utilities for 6b6t plugins.

net.blockhost.commons.database.postgres - package net.blockhost.commons.database.postgres

PostgreSQL database utilities for 6b6t plugins.

net.blockhost.commons.database.redis - package net.blockhost.commons.database.redis

Redis database utilities for 6b6t plugins.

net.blockhost.commons.message - package net.blockhost.commons.message

Message utilities for 6b6t plugins.

noCommands - Variable in class net.blockhost.commons.commands.help.HelpConfig

noMigrationNeeded() - Method in class net.blockhost.commons.config.migration.MigrationResult.Builder

Builds a result indicating no migration was needed.

noMigrationNeeded(int, Map) - Static method in interface net.blockhost.commons.config.migration.MigrationResult

Creates a result indicating no migration was needed.

O

of(int, int, String, Migration.MigrationAction) - Static method in interface net.blockhost.commons.config.migration.Migration: Creates a migration with explicit source and target versions.
of(int, String, Migration.MigrationAction) - Static method in interface net.blockhost.commons.config.migration.Migration: Creates a simple migration using a lambda expression.
of(Path, Map, int, int) - Static method in class net.blockhost.commons.config.migration.MigrationContext: Creates a new migration context.
of(Collection) - Static method in class net.blockhost.commons.config.migration.MigrationRegistry: Creates a registry pre-populated with the given migrations.
of(Migration...) - Static method in class net.blockhost.commons.config.migration.ConfigMigrator: Creates a simple migrator with the given migrations.
of(Migration...) - Static method in class net.blockhost.commons.config.migration.MigrationRegistry: Creates a registry pre-populated with the given migrations.
ofData(Map, int, int) - Static method in class net.blockhost.commons.config.migration.MigrationContext: Creates a migration context without a file path (for in-memory migrations).
onError(Consumer) - Method in class net.blockhost.commons.config.migration.MigrationExecutor: Sets a callback to be invoked when a migration fails.
onError(Consumer) - Method in class net.blockhost.commons.config.migration.ConfigMigrator.Builder: Sets a callback to be invoked when a migration fails.
onMigrationComplete(Migration, MigrationContext) - Method in interface net.blockhost.commons.config.migration.MigrationExecutor.MigrationCallback: Called after a migration completes successfully.
onReload(Consumer) - Method in class net.blockhost.commons.config.ConfigurationHolder: Sets a callback to be invoked after each reload.

P

parse(String) - Static method in class net.blockhost.commons.core.TimeFormatter: Parses a time string into a Duration.
parse(String) - Static method in class net.blockhost.commons.message.MessageService: Parses a MiniMessage string into a Component.
parse(String, Map) - Static method in class net.blockhost.commons.message.MessageService: Parses a MiniMessage string with placeholder replacements.
parse(String, TagResolver...) - Static method in class net.blockhost.commons.message.MessageService: Parses a MiniMessage string with tag resolvers.
parseToSeconds(String) - Static method in class net.blockhost.commons.core.TimeFormatter: Parses a time string into seconds.
password() - Method in class net.blockhost.commons.database.core.DatabaseCredentials
password() - Method in class net.blockhost.commons.database.mariadb.MariaDbConfig
password() - Method in class net.blockhost.commons.database.postgres.PostgresConfig
password() - Method in class net.blockhost.commons.database.redis.RedisConfig
password(String) - Method in class net.blockhost.commons.database.core.DatabaseCredentials.DatabaseCredentialsBuilder: Sets the password for authentication.
placeholder(String, String) - Static method in class net.blockhost.commons.message.MessageService: Creates a placeholder resolver for a key-value pair.
placeholder(String, Component) - Static method in class net.blockhost.commons.message.MessageService: Creates a placeholder resolver for a key-component pair.
PooledDatabaseConfig - Interface in net.blockhost.commons.database.core: Interface for database configurations that support HikariCP connection pooling.
poolName(String) - Method in class net.blockhost.commons.database.core.HikariDataSourceBuilder: Sets the name of the connection pool.
poolName(String) - Method in class net.blockhost.commons.database.core.SQLManager.Builder: Sets the connection pool name.
port() - Method in class net.blockhost.commons.database.mariadb.MariaDbConfig
port() - Method in class net.blockhost.commons.database.postgres.PostgresConfig
port() - Method in class net.blockhost.commons.database.redis.RedisConfig
PostgresConfig - Class in net.blockhost.commons.database.postgres: ConfigLib-compatible PostgreSQL database configuration class.
PostgresConfig() - Constructor for class net.blockhost.commons.database.postgres.PostgresConfig
PostgresConfig(String, int, String, String, String, int, int, int) - Constructor for class net.blockhost.commons.database.postgres.PostgresConfig
preparedStatementCacheSize(int) - Method in class net.blockhost.commons.database.core.HikariDataSourceBuilder: Sets the prepared statement cache size.
preparedStatementCacheSqlLimit(int) - Method in class net.blockhost.commons.database.core.HikariDataSourceBuilder: Sets the maximum length of a prepared statement SQL that can be cached.
privateCommand() - Method in class net.blockhost.commons.commands.help.HelpCommandWrapper
PrivateCommand - Annotation Interface in net.blockhost.commons.commands.help
properties() - Method in class net.blockhost.commons.database.core.DatabaseCredentials
properties(Map) - Method in class net.blockhost.commons.database.core.DatabaseCredentials.DatabaseCredentialsBuilder
property(String, String) - Method in class net.blockhost.commons.database.core.DatabaseCredentials.DatabaseCredentialsBuilder

R

RawYamlLoader - Class in net.blockhost.commons.config.migration: Utility class for loading and saving raw YAML files as Map structures.
readVersion(Path) - Static method in class net.blockhost.commons.config.migration.RawYamlLoader: Reads the version field from a YAML file.
reconnect() - Method in class net.blockhost.commons.database.core.SQLManager: Attempts to reconnect to the database.
reconnect() - Method in class net.blockhost.commons.database.redis.RedisManager: Attempts to reconnect to Redis.
RedisConfig - Class in net.blockhost.commons.database.redis: ConfigLib-compatible Redis configuration class.
RedisConfig() - Constructor for class net.blockhost.commons.database.redis.RedisConfig
RedisConfig(String, int, String, int, int, int, int, int, int, boolean) - Constructor for class net.blockhost.commons.database.redis.RedisConfig
RedisManager - Class in net.blockhost.commons.database.redis: Redis connection manager with Jedis connection pooling.
RedisManager.Builder - Class in net.blockhost.commons.database.redis: Builder for creating RedisManager instances.
register(Migration) - Method in class net.blockhost.commons.config.migration.ConfigMigrator.Builder: Registers a migration.
register(Migration) - Method in class net.blockhost.commons.config.migration.MigrationRegistry: Registers a migration.
registerAll(Collection) - Method in class net.blockhost.commons.config.migration.MigrationRegistry: Registers multiple migrations.
registerAll(Migration...) - Method in class net.blockhost.commons.config.migration.ConfigMigrator.Builder: Registers multiple migrations.
registerAll(Migration...) - Method in class net.blockhost.commons.config.migration.MigrationRegistry: Registers multiple migrations.
registerMigration(int, String, String) - Method in class net.blockhost.commons.database.core.SQLManager: Registers a database migration.
registerOrReplace(Migration) - Method in class net.blockhost.commons.config.migration.MigrationRegistry: Registers a migration, replacing any existing migration for the same target version.
registerTable(String) - Method in class net.blockhost.commons.database.core.SQLManager: Registers a table creation SQL statement.
registry() - Method in class net.blockhost.commons.config.migration.ConfigMigrator: Returns the migration registry.
registry() - Method in class net.blockhost.commons.config.migration.MigrationExecutor: Returns the registry used by this executor.
reload() - Method in class net.blockhost.commons.config.ConfigurationHolder: Reloads the configuration from disk.
reload(DatabaseCredentials) - Method in class net.blockhost.commons.database.core.SQLManager: Reloads the database configuration and reconnects.
reload(RedisConfig) - Method in class net.blockhost.commons.database.redis.RedisManager: Reloads the Redis configuration and reconnects.
remove(int) - Method in class net.blockhost.commons.config.migration.MigrationRegistry: Removes the migration for the specified target version.
rename(String, String) - Method in class net.blockhost.commons.config.migration.MigrationContext: Renames a key in the data map.
renameNested(String, String, String) - Method in class net.blockhost.commons.config.migration.MigrationContext: Renames a key within a nested map.
requiresAuth() - Method in class net.blockhost.commons.database.redis.RedisConfig: Checks if authentication is required.
resolvers(TagResolver...) - Static method in class net.blockhost.commons.message.MessageService: Combines multiple tag resolvers into one.
run(CommandContext) - Method in class net.blockhost.commons.commands.help.HelpCommandWrapper

S

save() - Method in class net.blockhost.commons.config.ConfigurationHolder: Saves the current configuration to disk.
save(OutputStream, Map) - Static method in class net.blockhost.commons.config.migration.RawYamlLoader: Saves YAML data to an output stream.
save(Writer, Map) - Static method in class net.blockhost.commons.config.migration.RawYamlLoader: Saves YAML data to a writer.
save(Path, Class) - Method in class net.blockhost.commons.config.ConfigurationHolder: Saves the current configuration to disk.
save(Path, Class, T, YamlConfigurationProperties) - Static method in class net.blockhost.commons.config.ConfigLoader: Saves a configuration to the specified path.
save(Path, Map) - Static method in class net.blockhost.commons.config.migration.RawYamlLoader: Saves YAML data to a file path atomically.
saveToString(Map) - Static method in class net.blockhost.commons.config.migration.RawYamlLoader: Converts YAML data to a string.
send(Audience, String) - Method in class net.blockhost.commons.message.MessageService: Sends a message to an audience.
send(Audience, String, Map) - Method in class net.blockhost.commons.message.MessageService: Sends a message to an audience with placeholder replacements.
send(Audience, String, TagResolver...) - Method in class net.blockhost.commons.message.MessageService: Sends a message to an audience with tag resolvers.
sendDefaultHelp(CommandContext, Function) - Static method in class net.blockhost.commons.commands.help.HelpInjector
sendHelp(Audience, List) - Method in class net.blockhost.commons.commands.help.HelpFormatter: Sends a help message to the given audience.
sendMockHelp(Audience) - Method in class net.blockhost.commons.commands.help.HelpFormatter: Sends a mock help message for testing purposes.
sendRaw(Audience, String) - Method in class net.blockhost.commons.message.MessageService: Sends a raw MiniMessage string to an audience.
sendRaw(Audience, String, TagResolver...) - Method in class net.blockhost.commons.message.MessageService: Sends a raw MiniMessage string to an audience with tag resolvers.
separator - Variable in class net.blockhost.commons.commands.help.HelpConfig
serialize(String) - Method in class net.blockhost.commons.message.MiniMessageConfigSerializer: Serializes a MiniMessage string for storage.
setDefault(String, Object) - Method in class net.blockhost.commons.config.migration.MigrationContext: Sets a value in the data map if the key is not already present.
shutdown() - Method in class net.blockhost.commons.database.core.SQLManager: Shuts down the connection pool.
shutdown() - Method in class net.blockhost.commons.database.redis.RedisManager: Shuts down the connection pool.
size() - Method in class net.blockhost.commons.config.migration.MigrationRegistry: Returns the number of registered migrations.
socketTimeoutMs() - Method in class net.blockhost.commons.database.redis.RedisConfig
sourceVersion() - Method in interface net.blockhost.commons.config.migration.Migration: Returns the version this migration upgrades from.
SQLManager - Class in net.blockhost.commons.database.core: Generic SQL connection manager with HikariCP connection pooling.
SQLManager.Builder - Class in net.blockhost.commons.database.core: Builder for creating SQLManager instances.
SQLManager.ConnectionConsumer - Interface in net.blockhost.commons.database.core: Functional interface for connection consumers that may throw SQLException.
SQLManager.ConnectionFunction<T> - Interface in net.blockhost.commons.database.core: Functional interface for connection functions that may throw SQLException.
ssl() - Method in class net.blockhost.commons.database.redis.RedisConfig
startStep() - Method in class net.blockhost.commons.config.migration.MigrationResult.Builder: Marks the start of a migration step.
steps() - Method in record class net.blockhost.commons.config.migration.MigrationResult.Failure: Returns the value of the steps record component.
steps() - Method in interface net.blockhost.commons.config.migration.MigrationResult: Returns the list of migration steps that were applied.
steps() - Method in record class net.blockhost.commons.config.migration.MigrationResult.Success: Returns the value of the steps record component.
strictMode(boolean) - Method in class net.blockhost.commons.config.migration.ConfigMigrator.Builder: Enables or disables strict mode.
strictMode(boolean) - Method in class net.blockhost.commons.config.migration.MigrationExecutor: Enables or disables strict mode.
success(int, int, List, Duration, Map) - Static method in interface net.blockhost.commons.config.migration.MigrationResult: Creates a successful migration result.
Success(int, int, List, Duration, Map) - Constructor for record class net.blockhost.commons.config.migration.MigrationResult.Success: Creates an instance of a Success record class.

T

targetVersion() - Method in interface net.blockhost.commons.config.migration.Migration: Returns the version this migration upgrades to.
targetVersion() - Method in class net.blockhost.commons.config.migration.MigrationContext: Returns the target version to migrate to.
TimeFormatter - Class in net.blockhost.commons.core: Utility class for formatting time durations into human-readable strings.
toBuilder() - Method in class net.blockhost.commons.database.core.DatabaseCredentials
toCredentials() - Method in interface net.blockhost.commons.database.core.PooledDatabaseConfig: Converts this configuration to database credentials.
toCredentials() - Method in class net.blockhost.commons.database.mariadb.MariaDbConfig
toCredentials() - Method in class net.blockhost.commons.database.postgres.PostgresConfig
toString() - Method in record class net.blockhost.commons.commands.help.HelpFormatter.CommandEntry: Returns a string representation of this record class.
toString() - Method in class net.blockhost.commons.config.migration.MigrationContext
toString() - Method in class net.blockhost.commons.config.migration.MigrationRegistry
toString() - Method in record class net.blockhost.commons.config.migration.MigrationResult.Failure: Returns a string representation of this record class.
toString() - Method in record class net.blockhost.commons.config.migration.MigrationResult.MigrationStep: Returns a string representation of this record class.
toString() - Method in record class net.blockhost.commons.config.migration.MigrationResult.Success: Returns a string representation of this record class.
toString() - Method in class net.blockhost.commons.database.core.DatabaseCredentials.DatabaseCredentialsBuilder
toVersion() - Method in record class net.blockhost.commons.config.migration.MigrationResult.Failure: Returns the value of the toVersion record component.
toVersion() - Method in record class net.blockhost.commons.config.migration.MigrationResult.MigrationStep: Returns the value of the toVersion record component.
toVersion() - Method in record class net.blockhost.commons.config.migration.MigrationResult.Success: Returns the value of the toVersion record component.
toVersion() - Method in interface net.blockhost.commons.config.migration.MigrationResult: Returns the version the data is at after migration.

U

updateIfChanged(Path, Class, YamlConfigurationProperties) - Static method in class net.blockhost.commons.config.ConfigLoader: Updates a configuration file with custom properties, only writing if changed.
username() - Method in class net.blockhost.commons.database.core.DatabaseCredentials
username() - Method in class net.blockhost.commons.database.mariadb.MariaDbConfig
username() - Method in class net.blockhost.commons.database.postgres.PostgresConfig
username(String) - Method in class net.blockhost.commons.database.core.DatabaseCredentials.DatabaseCredentialsBuilder: Sets the username for authentication.
useTimestampedBackups(boolean) - Method in class net.blockhost.commons.config.migration.ConfigMigrator.Builder: Enables timestamped backups.

V

validationTimeout(Duration) - Method in class net.blockhost.commons.database.core.HikariDataSourceBuilder: Sets the timeout for connection validation.
value() - Element in annotation interface net.blockhost.commons.commands.help.CommandDescription
version() - Method in class net.blockhost.commons.config.VersionAwareConfiguration: Returns the current schema version of this configuration.
VersionAwareConfiguration - Class in net.blockhost.commons.config: Base class for configuration files that support versioned migrations.
VersionAwareConfiguration(int) - Constructor for class net.blockhost.commons.config.VersionAwareConfiguration: Creates a new version-aware configuration with the specified default version.
versionMismatch(int, int) - Static method in exception class net.blockhost.commons.config.migration.MigrationException: Creates a migration exception indicating a version mismatch.

W

warningLogger(Consumer) - Method in class net.blockhost.commons.database.core.SQLManager.Builder: Sets a custom warning log consumer.
warningLogger(Consumer) - Method in class net.blockhost.commons.database.redis.RedisManager.Builder: Sets a custom warning log consumer.
withConnection(Consumer) - Method in class net.blockhost.commons.database.redis.RedisManager: Executes an action with a Redis connection.
withConnection(SQLManager.ConnectionConsumer) - Method in class net.blockhost.commons.database.core.SQLManager: Executes an action with a database connection.
withConnectionResult(Function) - Method in class net.blockhost.commons.database.redis.RedisManager: Executes an action with a Redis connection and returns a result.
withConnectionResult(SQLManager.ConnectionFunction) - Method in class net.blockhost.commons.database.core.SQLManager: Executes an action with a database connection and returns a result.
withConnectionTimeoutMs(int) - Method in class net.blockhost.commons.database.redis.RedisConfig
withConnectionTimeoutSeconds(int) - Method in class net.blockhost.commons.database.mariadb.MariaDbConfig
withConnectionTimeoutSeconds(int) - Method in class net.blockhost.commons.database.postgres.PostgresConfig
withDatabase(int) - Method in class net.blockhost.commons.database.redis.RedisConfig
withDatabase(String) - Method in class net.blockhost.commons.database.mariadb.MariaDbConfig
withDatabase(String) - Method in class net.blockhost.commons.database.postgres.PostgresConfig
withHost(String) - Method in class net.blockhost.commons.database.mariadb.MariaDbConfig
withHost(String) - Method in class net.blockhost.commons.database.postgres.PostgresConfig
withHost(String) - Method in class net.blockhost.commons.database.redis.RedisConfig
withMaxIdle(int) - Method in class net.blockhost.commons.database.redis.RedisConfig
withMaxPoolSize(int) - Method in class net.blockhost.commons.database.mariadb.MariaDbConfig
withMaxPoolSize(int) - Method in class net.blockhost.commons.database.postgres.PostgresConfig
withMaxPoolSize(int) - Method in class net.blockhost.commons.database.redis.RedisConfig
withMinIdle(int) - Method in class net.blockhost.commons.database.mariadb.MariaDbConfig
withMinIdle(int) - Method in class net.blockhost.commons.database.postgres.PostgresConfig
withMinIdle(int) - Method in class net.blockhost.commons.database.redis.RedisConfig
withPassword(String) - Method in class net.blockhost.commons.database.mariadb.MariaDbConfig
withPassword(String) - Method in class net.blockhost.commons.database.postgres.PostgresConfig
withPassword(String) - Method in class net.blockhost.commons.database.redis.RedisConfig
withPort(int) - Method in class net.blockhost.commons.database.mariadb.MariaDbConfig
withPort(int) - Method in class net.blockhost.commons.database.postgres.PostgresConfig
withPort(int) - Method in class net.blockhost.commons.database.redis.RedisConfig
withSocketTimeoutMs(int) - Method in class net.blockhost.commons.database.redis.RedisConfig
withSsl(boolean) - Method in class net.blockhost.commons.database.redis.RedisConfig
withUsername(String) - Method in class net.blockhost.commons.database.mariadb.MariaDbConfig
withUsername(String) - Method in class net.blockhost.commons.database.postgres.PostgresConfig
wrapCommand(Command, Method) - Static method in class net.blockhost.commons.commands.help.HelpInjector
write(Path, byte[]) - Static method in class net.blockhost.commons.core.io.AtomicFileWriter: Writes the given byte array to the target path atomically.
write(Path, String) - Static method in class net.blockhost.commons.core.io.AtomicFileWriter: Writes the given string to the target path atomically using UTF-8 encoding.
write(Path, IOConsumer) - Static method in class net.blockhost.commons.core.io.AtomicFileWriter: Writes to the target path atomically using a consumer that receives an OutputStream.

A B C D E F G H I J L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form