Package io.javaoperatorsdk.operator.config.loader.provider

Class PropertiesConfigProvider

java.lang.Object

io.javaoperatorsdk.operator.config.loader.provider.PropertiesConfigProvider

All Implemented Interfaces:

ConfigProvider

public class PropertiesConfigProvider
extends Object
implements ConfigProvider

A ConfigProvider that resolves configuration values from a Properties file.

Keys are looked up as-is against the loaded properties. Supported value types are: String, Boolean, Integer, Long, Double, and Duration (ISO-8601 format, e.g. PT30S).

Constructor Summary

Constructors

Constructor	Description
PropertiesConfigProvider(String path)	Loads properties from the given file path.
PropertiesConfigProvider(Path path)	Loads properties from the given file path.
PropertiesConfigProvider(Properties properties)	Uses the supplied Properties instance directly.

Method Summary

Modifier and Type	Method	Description
<T> Optional<T>	getValue(String key, Class<T> type)	Returns the value associated with key, converted to type, or an empty Optional if the key is not set.
static PropertiesConfigProvider	systemProperties()	Returns a PropertiesConfigProvider backed by System.getProperties().

Methods inherited from class java.lang.Object

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

Constructor Details

PropertiesConfigProvider

public PropertiesConfigProvider(String path)

Loads properties from the given file path.

Throws:

UncheckedIOException - if the file cannot be read. Does not throw an exception if the file does not exist.

PropertiesConfigProvider

public PropertiesConfigProvider(Path path)

Loads properties from the given file path.

Throws:

UncheckedIOException - if the file cannot be read. Does not throw an exception if the file does not exist.

PropertiesConfigProvider

public PropertiesConfigProvider(Properties properties)

Uses the supplied Properties instance directly.

Method Details

systemProperties

public static PropertiesConfigProvider systemProperties()

Returns a PropertiesConfigProvider backed by System.getProperties().

getValue

public <T> Optional<T> getValue(String key,
 Class<T> type)

Description copied from interface: ConfigProvider

Returns the value associated with key, converted to type, or an empty Optional if the key is not set.

Specified by:

getValue in interface ConfigProvider

Type Parameters:

T - the value type

Parameters:

key - the dot-separated configuration key, e.g. josdk.cache.sync.timeout

type - the expected type of the value; supported types depend on the implementation

Returns:

an Optional containing the typed value, or empty if the key is absent