org.elasticsearch.common.util

Class ExtensionPoint.ClassMap<T>

java.lang.Object

org.elasticsearch.common.util.ExtensionPoint

org.elasticsearch.common.util.ExtensionPoint.ClassMap<T>

Direct Known Subclasses:

ExtensionPoint.SelectedType, Highlighters, Suggesters

Enclosing class:

ExtensionPoint

public static class ExtensionPoint.ClassMap<T>
extends ExtensionPoint

A map based extension point which allows to register keyed implementations ie. parsers or some kind of strategies.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.common.util.ExtensionPoint

ExtensionPoint.ClassMap<T>, ExtensionPoint.ClassSet<T>, ExtensionPoint.InstanceMap<K,V>, ExtensionPoint.SelectedType<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<T>	extensionClass

Fields inherited from class org.elasticsearch.common.util.ExtensionPoint

name, singletons

Constructor Summary

Constructors

Constructor and Description
ExtensionPoint.ClassMap(String name, Class<T> extensionClass, Set<String> reservedKeys, Class<?>... singletons) Creates a new ExtensionPoint.ClassMap

Method Summary

Methods

Modifier and Type	Method and Description
protected void	bindExtensions(Binder binder) Subclasses can bind their type, map or set extensions here.
Class<? extends T>	getExtension(String type) Returns the extension for the given key or null
void	registerExtension(String key, Class<? extends T> extension) Registers an extension class for a given key.

Methods inherited from class org.elasticsearch.common.util.ExtensionPoint

bind

Methods inherited from class java.lang.Object

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

Field Detail

extensionClass

protected final Class<T> extensionClass

Constructor Detail

ExtensionPoint.ClassMap

public ExtensionPoint.ClassMap(String name,
                       Class<T> extensionClass,
                       Set<String> reservedKeys,
                       Class<?>... singletons)

Creates a new ExtensionPoint.ClassMap

Parameters:

name - the human readable underscore case name of the extension poing. This is used in error messages etc.

extensionClass - the base class that should be extended

singletons - a list of singletons to bind with this extension point - these are bound in ExtensionPoint.bind(Binder)

reservedKeys - a set of reserved keys by internal implementations

Method Detail

getExtension

public Class<? extends T> getExtension(String type)

Returns the extension for the given key or null

registerExtension

public final void registerExtension(String key,
                     Class<? extends T> extension)

Registers an extension class for a given key. This method will thr

Parameters:

key - the extensions key

extension - the extension

Throws:

IllegalArgumentException - iff the key is already registered or if the key is a reserved key for an internal implementation

bindExtensions

protected final void bindExtensions(Binder binder)

Description copied from class: ExtensionPoint

Subclasses can bind their type, map or set extensions here.

Specified by:

bindExtensions in class ExtensionPoint