com.datastrato.gravitino

Class Config

java.lang.Object

com.datastrato.gravitino.Config

public abstract class Config
extends java.lang.Object

The Config class is responsible for managing configuration settings.

Constructor Summary

Constructors

Constructor and Description
Config() Constructs a Config instance and loads default configurations.
Config(boolean loadDefaults) Constructs a Config instance.

Method Summary

Modifier and Type	Method and Description
<T> T	get(ConfigEntry<T> entry) Gets the value of a configuration entry.
java.util.Map<java.lang.String,java.lang.String>	getAllConfig() Retrieves a map containing all configuration entries.
java.util.Map<java.lang.String,java.lang.String>	getConfigsWithPrefix(java.lang.String prefix) Retrieves a map containing configuration entries that have keys with the specified prefix.
java.lang.String	getRawString(java.lang.String key) Retrieves the raw string value associated with the specified configuration key.
java.lang.String	getRawString(java.lang.String key, java.lang.String defaultValue) Retrieves the raw string value associated with the specified configuration key, providing a default value if the key is not found.
Config	loadFromFile(java.lang.String name) Loads configurations from a properties file.
void	loadFromMap(java.util.Map<java.lang.String,java.lang.String> map, java.util.function.Predicate<java.lang.String> predicate) Loads configurations from a map.
void	loadFromProperties(java.util.Properties properties) Loads configurations from properties.
java.util.Properties	loadPropertiesFromFile(java.io.File file) Loads properties from a file.
<T> void	set(ConfigEntry<T> entry, T value) Sets the value of a configuration entry.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Config

public Config(boolean loadDefaults)

Constructs a Config instance.

Parameters:

loadDefaults - Set to true if default configurations should be loaded.

Config

public Config()

Constructs a Config instance and loads default configurations.

Method Detail

loadFromFile

public Config loadFromFile(java.lang.String name)
                    throws java.lang.Exception

Loads configurations from a properties file.

Parameters:

name - The name of the properties file.

Returns:

The Config instance.

Throws:

java.lang.Exception - If there's an issue loading the properties.

get

public <T> T get(ConfigEntry<T> entry)
          throws java.util.NoSuchElementException

Gets the value of a configuration entry.

Type Parameters:

T - The type of the configuration value.

Parameters:

entry - The configuration entry to retrieve.

Returns:

The value of the configuration entry.

Throws:

java.util.NoSuchElementException - If the configuration entry is not found.

getRawString

public java.lang.String getRawString(java.lang.String key)

Retrieves the raw string value associated with the specified configuration key.

Parameters:

key - The configuration key for which the raw string value is requested.

Returns:

The raw string value associated with the given configuration key, or null if the key is not found.

getRawString

public java.lang.String getRawString(java.lang.String key,
                                     java.lang.String defaultValue)

Retrieves the raw string value associated with the specified configuration key, providing a default value if the key is not found.

Parameters:

key - The configuration key for which the raw string value is requested.

defaultValue - The default value to be returned if the key is not found.

Returns:

The raw string value associated with the given configuration key, or the provided default value if the key is not found.

getConfigsWithPrefix

public java.util.Map<java.lang.String,java.lang.String> getConfigsWithPrefix(java.lang.String prefix)

Retrieves a map containing configuration entries that have keys with the specified prefix.

Parameters:

prefix - The prefix that configuration keys should start with.

Returns:

An unmodifiable map containing configuration entries with keys matching the prefix.

getAllConfig

public java.util.Map<java.lang.String,java.lang.String> getAllConfig()

Retrieves a map containing all configuration entries.

Returns:

An unmodifiable map containing all configuration entries.

set

public <T> void set(ConfigEntry<T> entry,
                    T value)

Sets the value of a configuration entry.

Type Parameters:

T - The type of the configuration value.

Parameters:

entry - The configuration entry for which the value needs to be set.

value - The new value to be assigned to the configuration entry.

loadFromMap

public void loadFromMap(java.util.Map<java.lang.String,java.lang.String> map,
                        java.util.function.Predicate<java.lang.String> predicate)

Loads configurations from a map.

Parameters:

map - The map containing configuration key-value pairs.

predicate - The keys only match the predicate will be loaded to configMap

loadFromProperties

public void loadFromProperties(java.util.Properties properties)

Loads configurations from properties.

Parameters:

properties - The properties object containing configuration key-value pairs.

loadPropertiesFromFile

public java.util.Properties loadPropertiesFromFile(java.io.File file)
                                            throws java.io.IOException

Loads properties from a file.

Parameters:

file - The properties file to load from.

Returns:

The loaded properties.

Throws:

java.io.IOException - If there's an issue loading the properties.