info.magnolia.config.registry

Class DefinitionQuery<T>

java.lang.Object

info.magnolia.config.registry.DefinitionQuery<T>

Type Parameters:

T - type of the expected query result

public abstract class DefinitionQuery<T>
extends Object

DefinitionQuery aggregates metadata search criteria allowing for specifying it in a builder-pattern fashion.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefinitionQuery()
protected	DefinitionQuery(DefinitionQuery query) Create a new query instance based on another one.

Method Summary

Modifier and Type	Method and Description
DefinitionQuery<T>	at(Pattern locationRegexPattern)
DefinitionQuery<T>	at(String locationRegexPattern)
static <T> DefinitionQuery<T>	build(Registry<T> registry) Start building a DefinitionQuery for a Registry.
static <T> DefinitionQuery<T>	build(Registry<T> registry, DefinitionQuery<T> baseQuery) Start building a DefinitionQuery for a Registry, copying properties of an existing query.
abstract Collection<DefinitionProvider<T>>	findMultiple() Returns all providers matching the given criteria or an empty collection if there are no matches.
DefinitionProvider<T>	findSingle() Returns a single provider matching the criteria or throws an exception if not unique.
DefinitionQuery<T>	from(String moduleName)
ConfigurationSourceType	getConfigurationSourceType()
Pattern	getLocationPattern()
String	getModule()
String	getName()
DefinitionType	getType()
DefinitionQuery<T>	named(String defName)
DefinitionQuery<T>	ofConfigurationSourceType(ConfigurationSourceType configurationSourceType)
DefinitionQuery<T>	ofType(DefinitionType type)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefinitionQuery

protected DefinitionQuery()

DefinitionQuery

protected DefinitionQuery(DefinitionQuery query)

Create a new query instance based on another one. All properties are initially adopted, but can still be overridden.

Parameters:

query - The query to wrap/fork

Method Detail

build

public static <T> DefinitionQuery<T> build(Registry<T> registry)

Start building a DefinitionQuery for a Registry.

build

public static <T> DefinitionQuery<T> build(Registry<T> registry,
                                           DefinitionQuery<T> baseQuery)

Start building a DefinitionQuery for a Registry, copying properties of an existing query.

Parameters:

baseQuery - A DefinitionQuery to base the new one upon

from

public DefinitionQuery<T> from(String moduleName)

named

public DefinitionQuery<T> named(String defName)

ofType

public DefinitionQuery<T> ofType(DefinitionType type)

ofConfigurationSourceType

public DefinitionQuery<T> ofConfigurationSourceType(ConfigurationSourceType configurationSourceType)

at

public DefinitionQuery<T> at(String locationRegexPattern)

at

public DefinitionQuery<T> at(Pattern locationRegexPattern)

getModule

public String getModule()

getName

public String getName()

getType

public DefinitionType getType()

getConfigurationSourceType

public ConfigurationSourceType getConfigurationSourceType()

getLocationPattern

public Pattern getLocationPattern()

findSingle

public DefinitionProvider<T> findSingle()

Returns a single provider matching the criteria or throws an exception if not unique.

Throws:

Registry.NoSuchDefinitionException - (which is a RuntimeException) if the query doesn't match any definition.

findMultiple

public abstract Collection<DefinitionProvider<T>> findMultiple()

Returns all providers matching the given criteria or an empty collection if there are no matches.

toString

public String toString()

Overrides:

toString in class Object