Module io.inverno.mod.configuration

Package io.inverno.mod.configuration.source

Class CompositeConfigurationSource.CompositeListConfigurationQuery

java.lang.Object

io.inverno.mod.configuration.source.CompositeConfigurationSource.CompositeListConfigurationQuery

All Implemented Interfaces:

ListConfigurationQuery<CompositeConfigurationSource.CompositeListConfigurationQuery>

Enclosing class:

CompositeConfigurationSource

public static class CompositeConfigurationSource.CompositeListConfigurationQuery
extends Object
implements ListConfigurationQuery<CompositeConfigurationSource.CompositeListConfigurationQuery>

The list configuration query used by the composite configuration source.

Since:

1.0

Author:

Jeremy Kuhn

See Also:

• ListConfigurationQuery

Method Summary

Modifier and Type	Method	Description
Flux<ConfigurationProperty>	execute()	Lists all properties with the specified property name and whose parameters exactly match the query.
Flux<ConfigurationProperty>	executeAll()	Lists all properties with the specified property name and whose parameters match the query.
CompositeConfigurationSource.CompositeListConfigurationQuery	withParameters(List<ConfigurationKey.Parameter> parameters)	Defines parameters that specify the context in which configuration properties are to be retrieved.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.inverno.mod.configuration.ListConfigurationQuery

withParameters, withParameters, withParameters, withParameters, withParameters, withParameters, withParameters, withParameters, withParameters, withParameters, withParameters

Method Details

withParameters

public CompositeConfigurationSource.CompositeListConfigurationQuery withParameters(List<ConfigurationKey.Parameter> parameters)
                                                                            throws IllegalArgumentException

Description copied from interface: ListConfigurationQuery

Defines parameters that specify the context in which configuration properties are to be retrieved.

Specified by:

withParameters in interface ListConfigurationQuery<CompositeConfigurationSource.CompositeListConfigurationQuery>

Parameters:

parameters - a list of parameters

Returns:

the configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

execute

public Flux<ConfigurationProperty> execute()

Description copied from interface: ListConfigurationQuery

Lists all properties with the specified property name and whose parameters exactly match the query.

This method returns properties whose parameters exactly match the parameters specified in the query and exclude those defined with extra parameters.

Specified by:

execute in interface ListConfigurationQuery<CompositeConfigurationSource.CompositeListConfigurationQuery>

Returns:

a stream of configuration properties

executeAll

public Flux<ConfigurationProperty> executeAll()

Description copied from interface: ListConfigurationQuery

Lists all properties with the specified property name and whose parameters match the query.

This method returns all properties whose parameters match the parameters specified in the query without excluding those defined with extra parameters.

Specified by:

executeAll in interface ListConfigurationQuery<CompositeConfigurationSource.CompositeListConfigurationQuery>

Returns:

a stream of configuration properties