Package net.sf.basedb.util.extensions
Class ExtensionPointBean<A extends Action>
java.lang.Object
net.sf.basedb.util.extensions.ExtensionPointBean<A>
- All Implemented Interfaces:
ExtensionPoint<A>
A bean-like implementation of the
ExtensionPoint
interface. This implementation adds setter methods for simple
initialisation of the bean properties.- Version:
- 2.7
- Author:
- nicklas
- Last modified
- $Date:2008-03-20 12:15:25 +0100 (Thu, 20 Mar 2008) $
-
Field Summary
Modifier and TypeFieldDescriptionprivate boolean
private String
private ErrorHandlerFactory<? super A>
private String
private String
private RendererFactory<? super A>
-
Constructor Summary
ConstructorDescriptionCreate a new empty extension point bean.ExtensionPointBean
(String id, String name, String description, Class<A> actionClass, RendererFactory<A> rendererFactory, boolean allowRendererOverride) Create a new fully initialised extension point bean. -
Method Summary
Modifier and TypeMethodDescriptionboolean
If an extension is allowed to override the renderer factory with an implementation of its own.Get the class object that represents the type of action that can be added to this extension point.Get a description of the extension point.ErrorHandlerFactory<? super A>
Get the error handler factory that should be used with this extension point.getId()
Get the ID of the extension point.getName()
Get the name of the extension point.RendererFactory<? super A>
This is an optional factory for creatingRenderer
instances.void
setActionClass
(Class<A> actionClass) void
setAllowRendererOverrider
(boolean allowRendererOverride) void
setDescription
(String description) void
setErrorHandlerFactory
(ErrorHandlerFactory<? super A> errorHandlerFactory) void
void
void
setRendererFactory
(RendererFactory<? super A> rendererFactory) toString()
-
Field Details
-
id
-
name
-
description
-
actionClass
-
rendererFactory
-
allowRendererOverride
private boolean allowRendererOverride -
errorHandlerFactory
-
-
Constructor Details
-
ExtensionPointBean
public ExtensionPointBean()Create a new empty extension point bean. Use the setter methods to set the properties before registering the extension withRegistry.registerExtensionPoint(ExtensionPoint, ClassLoader)
. -
ExtensionPointBean
public ExtensionPointBean(String id, String name, String description, Class<A> actionClass, RendererFactory<A> rendererFactory, boolean allowRendererOverride) Create a new fully initialised extension point bean. See theExtensionPoint
interface for a description of the parameters.
-
-
Method Details
-
toString
-
getId
Description copied from interface:ExtensionPoint
Get the ID of the extension point.- Specified by:
getId
in interfaceExtensionPoint<A extends Action>
- Returns:
- A non-null unique identifier value
-
setId
-
getName
Description copied from interface:ExtensionPoint
Get the name of the extension point. This is just for display purposes and the value is optional. If no name is given the ID can be used instead.- Specified by:
getName
in interfaceExtensionPoint<A extends Action>
-
setName
-
getDescription
Description copied from interface:ExtensionPoint
Get a description of the extension point. This value is optional but we recommend that the description contains a text documenting the extension point and has information that is useful for everyone who wants to implement extensions for the extension point. This should include context specific information.- Specified by:
getDescription
in interfaceExtensionPoint<A extends Action>
- Returns:
- An optional description
-
setDescription
-
getActionClass
Description copied from interface:ExtensionPoint
Get the class object that represents the type of action that can be added to this extension point. The class must implement theAction
interface. Extensions that are extending this extension point must provide anActionFactory
that is capable of creating instances of the specified class.- Specified by:
getActionClass
in interfaceExtensionPoint<A extends Action>
- Returns:
- The class of the actions that can be used on this extension point (required)
-
setActionClass
-
getRendererFactory
Description copied from interface:ExtensionPoint
This is an optional factory for creatingRenderer
instances. Renderers are not a required part of the extension system, but will make it easier to write the code for extension points.- Specified by:
getRendererFactory
in interfaceExtensionPoint<A extends Action>
- Returns:
- A renderer factory or null
-
setRendererFactory
-
allowRendererOverride
public boolean allowRendererOverride()Description copied from interface:ExtensionPoint
If an extension is allowed to override the renderer factory with an implementation of its own. This can be seen as a possibility where extensions can create their own look and feel. If strict compliance is needed overriding should of course not be allowed.- Specified by:
allowRendererOverride
in interfaceExtensionPoint<A extends Action>
- Returns:
- TRUE to allow extensions to override, FALSE otherwise
-
setAllowRendererOverrider
public void setAllowRendererOverrider(boolean allowRendererOverride) -
getErrorHandlerFactory
Description copied from interface:ExtensionPoint
Get the error handler factory that should be used with this extension point.- Specified by:
getErrorHandlerFactory
in interfaceExtensionPoint<A extends Action>
- Returns:
- An error handler factory, or null to use the system default
-
setErrorHandlerFactory
-