Package org.hibernate.search.engine.cfg.spi

Class ConfigurationScope

java.lang.Object

org.hibernate.search.engine.cfg.spi.ConfigurationScope

@Incubating
public final class ConfigurationScope
extends Object

Holds a configuration scope.

It is not expected for service implementors to create the scopes. Hibernate Search will create the scope itself, and it will pass a corresponding scope to the ConfigurationProvider whenever it is required.

Scope always starts as the global scope. This global scope should always be reachable through recursively accessing the parent scope, unless the current scope is already a global scope.

An example of a scope sequence:

• [namespace:global] -- scope always starts with the global scope
• [namespace:backend name:backend-name] -- next a backend scope with an optional backend named. If the name is not present, it means that scope represents a default backend.
• [namespace:index name:index-name] -- next is a scope specific to an index

See Also:

ConfigurationScopeNamespaces, ConfigurationProvider

Field Summary

Fields

Modifier and Type	Field	Description
static ConfigurationScope	GLOBAL

Method Summary

Modifier and Type	Method	Description
boolean	match(Predicate<ConfigurationScope> predicate)
boolean	matchAny(String namespace)
boolean	matchExact(String namespace)
boolean	matchExact(String namespace, String name)
String	name()
String	namespace()
ConfigurationScope	parent()
ConfigurationScope	reduce(String namespace, String name)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

GLOBAL

public static final ConfigurationScope GLOBAL

Method Detail

reduce

public ConfigurationScope reduce(String namespace,
                                 String name)

matchAny

public boolean matchAny(String namespace)

matchExact

public boolean matchExact(String namespace)

matchExact

public boolean matchExact(String namespace,
                          String name)

match

public boolean match(Predicate<ConfigurationScope> predicate)

parent

public ConfigurationScope parent()

namespace

public String namespace()

name

public String name()

toString

public String toString()

Overrides:

toString in class Object