org.elasticsearch.common.util

Class ExtensionPoint

java.lang.Object

org.elasticsearch.common.util.ExtensionPoint

Direct Known Subclasses:

ExtensionPoint.ClassMap, ExtensionPoint.ClassSet, ExtensionPoint.InstanceMap

public abstract class ExtensionPoint
extends Object

This class defines an official elasticsearch extension point. It registers all extensions by a single name and ensures that extensions are not registered more than once.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExtensionPoint.ClassMap<T> A map based extension point which allows to register keyed implementations ie.
static class	ExtensionPoint.ClassSet<T> A set based extension point which allows to register extended classes that might be used to chain additional functionality etc.
static class	ExtensionPoint.InstanceMap<K,V> A an instance of a map, mapping one instance value to another.
static class	ExtensionPoint.SelectedType<T> A Type extension point which basically allows to registerd keyed extensions like ExtensionPoint.ClassMap but doesn't instantiate and bind all the registered key value pairs but instead replace a singleton based on a given setting via ExtensionPoint.SelectedType.bindType(Binder, Settings, String, String) Note: bind(Binder) is not supported by this class

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name
protected Class<?>[]	singletons

Constructor Summary

Constructors

Constructor and Description
ExtensionPoint(String name, Class<?>... singletons) Creates a new extension point

Method Summary

Methods

Modifier and Type	Method and Description
void	bind(Binder binder) Binds the extension as well as the singletons to the given guice binder.
protected abstract void	bindExtensions(Binder binder) Subclasses can bind their type, map or set extensions here.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected final String name

singletons

protected final Class<?>[] singletons

Constructor Detail

ExtensionPoint

public ExtensionPoint(String name,
              Class<?>... singletons)

Creates a new extension point

Parameters:

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

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

Method Detail

bind

public final void bind(Binder binder)

Binds the extension as well as the singletons to the given guice binder.

Parameters:

binder - the binder to use

bindExtensions

protected abstract void bindExtensions(Binder binder)

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