Package-level declarations

Types

Link copied to clipboard
@Pattern(value = "^[a-zA-Z0-9_-]+\.(json)$")
annotation class JsonConfigFileNamePattern

Annotation to specify that a file name must follow a JSON configuration file name pattern. The file name must match the regular expression: ^[a-zA-Z0-9_-]+\\.(json)$.

Link copied to clipboard
interface SurfConfigApi

API for managing configuration files in the Surf API, supporting both Sponge and DazzlConf configurations. Provides methods to create, retrieve, and reload configuration files in various formats (YAML, JSON).

Link copied to clipboard
@Pattern(value = "^[a-zA-Z0-9_-]+\.(yml|yaml)$")
annotation class YamlConfigFileNamePattern

Annotation to specify that a file name must follow a YAML configuration file name pattern. The file name must match the regular expression: ^[a-zA-Z0-9_-]+\\.(yml|yaml)$.

Properties

Link copied to clipboard

Retrieves the singleton instance of SurfConfigApi.

Functions

Link copied to clipboard
inline fun <C> SurfConfigApi.createDazzlConfig(configFolder: Path, configFileName: @YamlConfigFileNamePattern String): C

Creates a DazzlConf configuration using a reified type.

Link copied to clipboard
inline fun <C> SurfConfigApi.createSpongeJsonConfig(configFolder: Path, configFileName: @JsonConfigFileNamePattern String): C

Creates a Sponge JSON configuration using a reified type.

Link copied to clipboard
inline fun <C> SurfConfigApi.createSpongeYmlConfig(configFolder: Path, configFileName: @YamlConfigFileNamePattern String): C

Creates a Sponge YAML configuration using a reified type.

Link copied to clipboard

Retrieves a DazzlConf configuration using a reified type.

Link copied to clipboard

Retrieves a Sponge configuration using a reified type.

Link copied to clipboard

Reloads a DazzlConf configuration using a reified type.