net.sf.basedb.util.extensions
Class ExtensionPointContext<A extends Action>

java.lang.Object
  net.sf.basedb.util.extensions.InvokationContext<A>
      net.sf.basedb.util.extensions.ExtensionPointContext<A>

 class ExtensionPointContext<A extends Action>
extends InvokationContext<A>

Invokation context for an extension point.

Version:

2.7

Author:

nicklas

Last modified

$Date: 2010-11-15 13:32:35 +0100 (Mon, 15 Nov 2010) $

Field Summary

private ClientContext	clientContext
private ErrorHandler<? super A>	errorHandler
private ErrorHandlerFactory<? super A>	errorHandlerFactory
private Registry.RegisteredExtensionPoint<A>	extensionPoint
private boolean	hasCreatedRenderer
private Registry	registry
private Renderer<? super A>	renderer

Constructor Summary

ExtensionPointContext(Registry registry, ClientContext clientContext, Registry.RegisteredExtensionPoint<A> extensionPoint, ErrorHandlerFactory<? super A> errorHandlerFactory)

Method Summary

protected void	clearError() Clear the registered error for the current extension or extension point.
protected A[]	getActions() Always null, since this is an extension point context.
Object	getAttribute(String name) Always null, since this is an extension point context.
ClientContext	getClientContext() Get the client context that was passed to the Registry.useExtensions(ClientContext, ExtensionsFilter, String...)
protected ErrorHandler<? super A>	getErrorHandler() Get the error handler used in this context.
Extension<A>	getExtension() Always null, since this is an extension point context.
ExtensionPoint<? super A>	getExtensionPoint() Get information about the extension point.
protected Registry	getRegistry() Get the registry where this invokation originated from.
protected Renderer<? super A>	getRenderer() If the extension point defines a renderer factory, creates a new renderer unless one already exists.
private void	handleError(String message, Throwable t)
protected void	prepareRendererFactory() Prepare the renderer factory if the extension or extension point has one.
protected void	setError(A action, Throwable t) Register an error for the current extension or extension point.

Methods inherited from class java.lang.Object

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

Field Detail

clientContext

private final ClientContext clientContext

registry

private final Registry registry

extensionPoint

private final Registry.RegisteredExtensionPoint<A extends Action> extensionPoint

errorHandlerFactory

private final ErrorHandlerFactory<? super A extends Action> errorHandlerFactory

renderer

private Renderer<? super A extends Action> renderer

hasCreatedRenderer

private boolean hasCreatedRenderer

errorHandler

private ErrorHandler<? super A extends Action> errorHandler

Constructor Detail

ExtensionPointContext

ExtensionPointContext(Registry registry,
                      ClientContext clientContext,
                      Registry.RegisteredExtensionPoint<A> extensionPoint,
                      ErrorHandlerFactory<? super A> errorHandlerFactory)

Method Detail

getClientContext

public ClientContext getClientContext()

Description copied from class: InvokationContext

Get the client context that was passed to the Registry.useExtensions(ClientContext, ExtensionsFilter, String...) method.

Specified by:

getClientContext in class InvokationContext<A extends Action>

Returns:

The client context, or null if the client didn't pass any context object

getExtensionPoint

public ExtensionPoint<? super A> getExtensionPoint()

Description copied from class: InvokationContext

Get information about the extension point.

Specified by:

getExtensionPoint in class InvokationContext<A extends Action>

Returns:

An extension point object

getExtension

public Extension<A> getExtension()

Always null, since this is an extension point context.

Specified by:

getExtension in class InvokationContext<A extends Action>

Returns:

An extension object, or null if there is no current extension

getAttribute

public Object getAttribute(String name)

Always null, since this is an extension point context.

Specified by:

getAttribute in class InvokationContext<A extends Action>

Parameters:

name - The name of the attribute

Returns:

The attribute value, or null if no attribute has been registered

See Also:

Registry.getAttribute(String, String)

getRegistry

protected Registry getRegistry()

Description copied from class: InvokationContext

Get the registry where this invokation originated from.

Specified by:

getRegistry in class InvokationContext<A extends Action>

prepareRendererFactory

protected void prepareRendererFactory()

Description copied from class: InvokationContext

Prepare the renderer factory if the extension or extension point has one.

Specified by:

prepareRendererFactory in class InvokationContext<A extends Action>

getRenderer

protected Renderer<? super A> getRenderer()

If the extension point defines a renderer factory, creates a new renderer unless one already exists.

Specified by:

getRenderer in class InvokationContext<A extends Action>

Returns:

A renderer, or null if no factory has been defined

getActions

protected A[] getActions()

Always null, since this is an extension point context.

Specified by:

getActions in class InvokationContext<A extends Action>

setError

protected void setError(A action,
                        Throwable t)

Description copied from class: InvokationContext

Register an error for the current extension or extension point. Registered errors can be retrieved by Registry.getLastExtensionError(String) and Registry.getLastExtensionPointError(String)

Specified by:

setError in class InvokationContext<A extends Action>

Parameters:

action - The action that caused the error

t - The error

clearError

protected void clearError()

Description copied from class: InvokationContext

Clear the registered error for the current extension or extension point.

Specified by:

clearError in class InvokationContext<A extends Action>

getErrorHandler

protected ErrorHandler<? super A> getErrorHandler()

Description copied from class: InvokationContext

Get the error handler used in this context. Should never be null, since if not the extension point provides one, the system should.

Specified by:

getErrorHandler in class InvokationContext<A extends Action>

handleError

private void handleError(String message,
                         Throwable t)