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

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 java.lang.Class<T>	extensionClass
protected java.util.Map<java.lang.String,java.lang.Class<? extends T>>	extensions

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

name, singletons

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	bindExtensions(Binder binder) Subclasses can bind their type, map or set extensions here.
java.lang.Class<? extends T>	getExtension(java.lang.String type) Returns the extension for the given key or null
void	registerExtension(java.lang.String key, java.lang.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 java.lang.Class<T> extensionClass

extensions

protected final java.util.Map<java.lang.String,java.lang.Class<? extends T>> extensions

Constructor Detail

ClassMap

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

Creates a new ExtensionPoint.ClassMap

Parameters:

name - the human readable underscore case name of the extension point. 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 java.lang.Class<? extends T> getExtension(java.lang.String type)

Returns the extension for the given key or null

registerExtension

public final void registerExtension(java.lang.String key,
                                    java.lang.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:

java.lang.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