Module io.inverno.mod.configuration

Package io.inverno.mod.configuration

Interface ListConfigurationQuery<A extends ListConfigurationQuery<A>>

Type Parameters:

A - the query type

All Known Implementing Classes:

AbstractHashConfigurationSource.HashListConfigurationQuery, AbstractPropertiesConfigurationSource.PropertyListConfigurationQuery, CompositeConfigurationSource.CompositeListConfigurationQuery, RedisConfigurationSource.RedisListConfigurationQuery, VersionedRedisConfigurationSource.VersionedRedisListConfigurationQuery

public interface ListConfigurationQuery<A extends ListConfigurationQuery<A>>

A list configuration query can be executed to retrieve all configuration properties defined with a specific set of parameters.

This type of query supports ConfigurationKey.WildcardParameter in order to list properties defined with a specific parameter regardless of the value.

Since:

1.4

Author:

Jeremy Kuhn

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.
default A	withParameters(ConfigurationKey.Parameter... parameters)	Defines parameters that specify the context in which configuration properties are to be retrieved.
default A	withParameters(String k1, Object v1)	Defines one parameter that specifies the context in which configuration properties are to be retrieved.
default A	withParameters(String k1, Object v1, String k2, Object v2)	Defines two parameters that specify the context in which configuration properties are to be retrieved.
default A	withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3)	Defines three parameters that specify the context in which configuration properties are to be retrieved.
default A	withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4)	Defines four parameters that specify the context in which configuration properties are to be retrieved.
default A	withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4, String k5, Object v5)	Defines five parameters that specify the context in which configuration properties are to be retrieved.
default A	withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4, String k5, Object v5, String k6, Object v6)	Defines six parameters that specify the context in which configuration properties are to be retrieved.
default A	withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4, String k5, Object v5, String k6, Object v6, String k7, Object v7)	Defines seven parameters that specify the context in which configuration properties are to be retrieved.
default A	withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4, String k5, Object v5, String k6, Object v6, String k7, Object v7, String k8, Object v8)	Defines eigth parameters that specify the context in which configuration properties are to be retrieved.
default A	withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4, String k5, Object v5, String k6, Object v6, String k7, Object v7, String k8, Object v8, String k9, Object v9)	Defines nine parameters that specify the context in which configuration properties are to be retrieved.
default A	withParameters(String k1, Object v1, String k2, Object v2, String k3, Object v3, String k4, Object v4, String k5, Object v5, String k6, Object v6, String k7, Object v7, String k8, Object v8, String k9, Object v9, String k10, Object v10)	Defines ten parameters that specify the context in which configuration properties are to be retrieved.
A	withParameters(List<ConfigurationKey.Parameter> parameters)	Defines parameters that specify the context in which configuration properties are to be retrieved.

Method Details

withParameters

default A withParameters(String k1,
 Object v1)

Defines one parameter that specifies the context in which configuration properties are to be retrieved.

Parameters:

k1 - the parameter name

v1 - the parameter value

Returns:

the configuration query

withParameters

default A withParameters(String k1,
 Object v1,
 String k2,
 Object v2)
                  throws IllegalArgumentException

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

Parameters:

k1 - the first parameter name

v1 - the first parameter value

k2 - the second parameter name

v2 - the second parameter value

Returns:

the configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withParameters

default A withParameters(String k1,
 Object v1,
 String k2,
 Object v2,
 String k3,
 Object v3)
                  throws IllegalArgumentException

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

Parameters:

k1 - the first parameter name

v1 - the first parameter value

k2 - the second parameter name

v2 - the second parameter value

k3 - the third parameter name

v3 - the third parameter value

Returns:

the configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withParameters

default A withParameters(String k1,
 Object v1,
 String k2,
 Object v2,
 String k3,
 Object v3,
 String k4,
 Object v4)
                  throws IllegalArgumentException

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

Parameters:

k1 - the first parameter name

v1 - the first parameter value

k2 - the second parameter name

v2 - the second parameter value

k3 - the third parameter name

v3 - the third parameter value

k4 - the fourth parameter name

v4 - the fourth parameter value

Returns:

the configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withParameters

default A withParameters(String k1,
 Object v1,
 String k2,
 Object v2,
 String k3,
 Object v3,
 String k4,
 Object v4,
 String k5,
 Object v5)
                  throws IllegalArgumentException

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

Parameters:

k1 - the first parameter name

v1 - the first parameter value

k2 - the second parameter name

v2 - the second parameter value

k3 - the third parameter name

v3 - the third parameter value

k4 - the fourth parameter name

v4 - the fourth parameter value

k5 - the fifth parameter name

v5 - the fifth parameter value

Returns:

the configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withParameters

default A withParameters(String k1,
 Object v1,
 String k2,
 Object v2,
 String k3,
 Object v3,
 String k4,
 Object v4,
 String k5,
 Object v5,
 String k6,
 Object v6)
                  throws IllegalArgumentException

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

Parameters:

k1 - the first parameter name

v1 - the first parameter value

k2 - the second parameter name

v2 - the second parameter value

k3 - the third parameter name

v3 - the third parameter value

k4 - the fourth parameter name

v4 - the fourth parameter value

k5 - the fifth parameter name

v5 - the fifth parameter value

k6 - the sixth parameter name

v6 - the sixth parameter value

Returns:

the configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withParameters

default A withParameters(String k1,
 Object v1,
 String k2,
 Object v2,
 String k3,
 Object v3,
 String k4,
 Object v4,
 String k5,
 Object v5,
 String k6,
 Object v6,
 String k7,
 Object v7)
                  throws IllegalArgumentException

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

Parameters:

k1 - the first parameter name

v1 - the first parameter value

k2 - the second parameter name

v2 - the second parameter value

k3 - the third parameter name

v3 - the third parameter value

k4 - the fourth parameter name

v4 - the fourth parameter value

k5 - the fifth parameter name

v5 - the fifth parameter value

k6 - the sixth parameter name

v6 - the sixth parameter value

k7 - the seventh parameter name

v7 - the seventh parameter value

Returns:

the configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withParameters

default A withParameters(String k1,
 Object v1,
 String k2,
 Object v2,
 String k3,
 Object v3,
 String k4,
 Object v4,
 String k5,
 Object v5,
 String k6,
 Object v6,
 String k7,
 Object v7,
 String k8,
 Object v8)
                  throws IllegalArgumentException

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

Parameters:

k1 - the first parameter name

v1 - the first parameter value

k2 - the second parameter name

v2 - the second parameter value

k3 - the third parameter name

v3 - the third parameter value

k4 - the fourth parameter name

v4 - the fourth parameter value

k5 - the fifth parameter name

v5 - the fifth parameter value

k6 - the sixth parameter name

v6 - the sixth parameter value

k7 - the seventh parameter name

v7 - the seventh parameter value

k8 - the eighth parameter name

v8 - the eighth parameter value

Returns:

the configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withParameters

default A withParameters(String k1,
 Object v1,
 String k2,
 Object v2,
 String k3,
 Object v3,
 String k4,
 Object v4,
 String k5,
 Object v5,
 String k6,
 Object v6,
 String k7,
 Object v7,
 String k8,
 Object v8,
 String k9,
 Object v9)
                  throws IllegalArgumentException

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

Parameters:

k1 - the first parameter name

v1 - the first parameter value

k2 - the second parameter name

v2 - the second parameter value

k3 - the third parameter name

v3 - the third parameter value

k4 - the fourth parameter name

v4 - the fourth parameter value

k5 - the fifth parameter name

v5 - the fifth parameter value

k6 - the sixth parameter name

v6 - the sixth parameter value

k7 - the seventh parameter name

v7 - the seventh parameter value

k8 - the eighth parameter name

v8 - the eighth parameter value

k9 - the ninth parameter name

v9 - the ninth parameter value

Returns:

the configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withParameters

default A withParameters(String k1,
 Object v1,
 String k2,
 Object v2,
 String k3,
 Object v3,
 String k4,
 Object v4,
 String k5,
 Object v5,
 String k6,
 Object v6,
 String k7,
 Object v7,
 String k8,
 Object v8,
 String k9,
 Object v9,
 String k10,
 Object v10)
                  throws IllegalArgumentException

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

Parameters:

k1 - the first parameter name

v1 - the first parameter value

k2 - the second parameter name

v2 - the second parameter value

k3 - the third parameter name

v3 - the third parameter value

k4 - the fourth parameter name

v4 - the fourth parameter value

k5 - the fifth parameter name

v5 - the fifth parameter value

k6 - the sixth parameter name

v6 - the sixth parameter value

k7 - the seventh parameter name

v7 - the seventh parameter value

k8 - the eighth parameter name

v8 - the eighth parameter value

k9 - the ninth parameter name

v9 - the ninth parameter value

k10 - the tenth parameter name

v10 - the tenth parameter value

Returns:

the configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withParameters

default A withParameters(ConfigurationKey.Parameter... parameters)
                  throws IllegalArgumentException

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

Parameters:

parameters - an array of parameters

Returns:

the configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

withParameters

A withParameters(List<ConfigurationKey.Parameter> parameters)
          throws IllegalArgumentException

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

Parameters:

parameters - a list of parameters

Returns:

the configuration query

Throws:

IllegalArgumentException - if parameters were specified more than once

execute

Flux<ConfigurationProperty> execute()

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.

Returns:

a stream of configuration properties

executeAll

Flux<ConfigurationProperty> executeAll()

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.

Returns:

a stream of configuration properties