org.forgerock.config.resolvers

Interface PropertyResolver

All Known Implementing Classes:

ChainedPropertyResolver, EnvironmentVariableResolver, FlatFileResolver, ProductPathResolver, SystemPropertyResolver

public interface PropertyResolver

A property resolver attempt to get the value of a given config property.

Method Summary

Modifier and Type	Method and Description
Optional<String>	getProperty(String key) Returns the value of the specified property.
default Optional<String>	getProperty(String key, String defaultValue) Returns the value of the specified property.

Method Detail

getProperty

Optional<String> getProperty(String key)

Returns the value of the specified property. The method returns an empty Optional if the property is not found.

Parameters:

key - The name of the requested property. The key can't be null.

Returns:

An Optional string that contains the value of the requested property, or empty Optional if property is undefined.

Throws:

NullPointerException - if key is null.

getProperty

default Optional<String> getProperty(String key,
                                     String defaultValue)

Returns the value of the specified property. The method returns an empty Optional if the property is not found and there is no default value provided.

Parameters:

key - The name of the requested property. The key can't be null.

defaultValue - The default value if the property is not defined.

Returns:

An Optional string that contains the value of the requested property, or empty Optional if property is undefined and a default is not supplied.

Throws:

NullPointerException - if key is null.