Module io.inverno.mod.configuration

Package io.inverno.mod.configuration

Interface ConfigurationQueryResult

All Known Implementing Classes:

AbstractHashConfigurationSource.HashConfigurationQueryResult, AbstractPropertiesConfigurationSource.PropertyConfigurationQueryResult, CompositeConfigurationSource.CompositeConfigurationQueryResult, io.inverno.mod.configuration.internal.GenericConfigurationQueryResult, VersionedRedisConfigurationSource.VersionedRedisConfigurationQueryResult

public interface ConfigurationQueryResult

Represents a single query result providing the configuration property retrieved from a configuration source with a query key.

Note that the query key and the property key may differs if the configuration source uses a defaulting mechanism to return the value that best matches the context specified in the query key.

Since:

1.0

Author:

Jeremy Kuhn

See Also:

• ConfigurationQuery
• ConfigurationSource

Method Summary

Modifier and Type	Method	Description
ConfigurationKey	getQueryKey()	Returns the configuration key corresponding to the query that was executed.
Optional<ConfigurationProperty>	getResult()	Returns the resulting configuration property.

Method Details

getQueryKey

ConfigurationKey getQueryKey()

Returns the configuration key corresponding to the query that was executed.

Returns:

a configuration key

getResult

Optional<ConfigurationProperty> getResult()
                                   throws ConfigurationSourceException

Returns the resulting configuration property.

Returns:

an optional returning the configuration property or an empty optional if the configuration returned no value for the property

Throws:

ConfigurationSourceException - if there was an error retrieving the configuration property