com.datastrato.gravitino.config

Class ConfigEntry<T>

java.lang.Object

com.datastrato.gravitino.config.ConfigEntry<T>

public class ConfigEntry<T>
extends java.lang.Object

Defines configuration properties.

Method Summary

Modifier and Type	Method and Description
ConfigEntry<T>	checkValue(java.util.function.Function<T,java.lang.Boolean> checkValueFunc, java.lang.String errorMsg) Checks if the user-provided value for the config matches the validator.
ConfigEntry<T>	create() Creates a new ConfigEntry instance based on this configuration entry with no default value.
ConfigEntry<T>	createWithDefault(T t) Creates a new ConfigEntry instance based on this configuration entry with a default value.
ConfigEntry<java.util.Optional<T>>	createWithOptional() Creates a new ConfigEntry instance based on this configuration entry with optional value handling.
T	readFrom(java.util.Map<java.lang.String,java.lang.String> properties) Reads the configuration value.
void	writeTo(java.util.Map<java.lang.String,java.lang.String> properties, T value) Writes the provided value to the specified properties map.

Methods inherited from class java.lang.Object

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

Method Detail

checkValue

public ConfigEntry<T> checkValue(java.util.function.Function<T,java.lang.Boolean> checkValueFunc,
                                 java.lang.String errorMsg)

Checks if the user-provided value for the config matches the validator.

Parameters:

checkValueFunc - The validator of the configuration option

errorMsg - The thrown error message if the value is invalid

Returns:

The current ConfigEntry instance

createWithDefault

public ConfigEntry<T> createWithDefault(T t)

Creates a new ConfigEntry instance based on this configuration entry with a default value.

Parameters:

t - The default value to be used when no value is provided.

Returns:

A new ConfigEntry instance with the specified default value.

createWithOptional

public ConfigEntry<java.util.Optional<T>> createWithOptional()

Creates a new ConfigEntry instance based on this configuration entry with optional value handling.

Returns:

A new ConfigEntry instance that works with optional values.

create

public ConfigEntry<T> create()

Creates a new ConfigEntry instance based on this configuration entry with no default value.

Returns:

A new ConfigEntry instance with no default value.

readFrom

public T readFrom(java.util.Map<java.lang.String,java.lang.String> properties)
           throws java.util.NoSuchElementException

Reads the configuration value.

Parameters:

properties - The map containing the configuration properties.

Returns:

The value of the configuration entry.

Throws:

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

writeTo

public void writeTo(java.util.Map<java.lang.String,java.lang.String> properties,
                    T value)

Writes the provided value to the specified properties map.

Parameters:

properties - The map to write the configuration property to.

value - The value of the configuration entry.