de.intarsys.tools.codeexit

Class CodeExit<T>

java.lang.Object

de.intarsys.tools.codeexit.CodeExit<T>

All Implemented Interfaces:

IDeclarationSupport, IFunctor<T>, IElementConfigurable, IElementSerializable, IPresentationSupport, IClassLoaderAccess, IClassLoaderSupport

public class CodeExit<T>
extends Object
implements IFunctor<T>, IClassLoaderAccess, IElementConfigurable, IElementSerializable, IDeclarationSupport, IPresentationSupport

A CodeExit is an IFunctor implemented in a "foreign" language such as a scripting language or a proprietary syntax.

This is a flexible and powerful pattern if you need pluggable functors in your application to dynamically add features.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EA_NAME
static String	EA_SOURCE
static String	EA_TYPE
static String	EE_ARG
static String	EE_DECLARATIONS
static String	EE_HANDLER

Fields inherited from interface de.intarsys.tools.presentation.IPresentationSupport

ATTR_DESCRIPTION, ATTR_ICON, ATTR_LABEL, ATTR_TIP

Constructor Summary

Constructors

Constructor and Description
CodeExit() A no-arg constructor for easy reflective access.
CodeExit(Object owner)

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(IElement pElement)
CodeExit<?>	copy()
static CodeExit<?>	createFromElement(IElement element)
boolean	exists()
ClassLoader	getClassLoader() The ClassLoader to be used when accessing resources.
ICodeExitHandler	getCodeExitHandler()
Object	getCompiledSource()
IDeclarationBlock	getDeclarationBlock() The block of declarations available so far for this.
String	getDescription() A long, descriptive string representation.
IElement	getElement() The IElement that was used to configure this.
IElement	getHandlerElement() The IElement that was used configured to be forwarded to a ICodeExitHandler.
String	getIconName() A name for an icon.
String	getLabel() A short string representation (suitable for example for use with an icon or menu item).
String	getName()
Object	getOwner() A generic link to an object that is the "owner" of this.
String	getSource() The source code.
String	getSourceExpanded(IArgs args)
String	getTip() An "intermediate" length description (suitable for example with a tooltip).
String	getType() The type.
boolean	isDefinedSource()
boolean	isDefinedType()
T	perform(IFunctorCall call) Perform the encapsulated business logic in the context defined in "call".
void	serialize(IElement element) Serialize the state in element.
void	setClassLoader(ClassLoader classLoader) Set the ClassLoader to be used with this CodeExit.
void	setCompiledSource(Object compiledSource)
void	setName(String name)
void	setOwner(Object owner) Set an owner for the CodeExit.
void	setSource(String value) Assign the source.
void	setType(String type) Assign the type.

Methods inherited from class java.lang.Object

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

Field Detail

EA_NAME

public static final String EA_NAME

See Also:

Constant Field Values

EE_ARG

public static final String EE_ARG

See Also:

Constant Field Values

EE_HANDLER

public static final String EE_HANDLER

See Also:

Constant Field Values

EE_DECLARATIONS

public static final String EE_DECLARATIONS

See Also:

Constant Field Values

EA_SOURCE

public static final String EA_SOURCE

See Also:

Constant Field Values

EA_TYPE

public static final String EA_TYPE

See Also:

Constant Field Values

Constructor Detail

CodeExit

public CodeExit()

A no-arg constructor for easy reflective access.

CodeExit

public CodeExit(Object owner)

Method Detail

createFromElement

public static CodeExit<?> createFromElement(IElement element)
                                     throws ObjectCreationException

Throws:

ObjectCreationException

configure

public void configure(IElement pElement)
               throws ConfigurationException

Specified by:

configure in interface IElementConfigurable

Throws:

ConfigurationException

copy

public CodeExit<?> copy()

exists

public boolean exists()

getClassLoader

public ClassLoader getClassLoader()

The ClassLoader to be used when accessing resources.

Specified by:

getClassLoader in interface IClassLoaderSupport

Returns:

The ClassLoader to be used when accessing resources.

getCodeExitHandler

public ICodeExitHandler getCodeExitHandler()

getCompiledSource

public Object getCompiledSource()

getDeclarationBlock

public IDeclarationBlock getDeclarationBlock()

Description copied from interface: IDeclarationSupport

The block of declarations available so far for this.

Specified by:

getDeclarationBlock in interface IDeclarationSupport

Returns:

The block of declarations available so far for this.

getDescription

public String getDescription()

Description copied from interface: IPresentationSupport

A long, descriptive string representation.

Specified by:

getDescription in interface IPresentationSupport

Returns:

A long, descriptive string representation.

getElement

public IElement getElement()

The IElement that was used to configure this.

Returns:

The element that was used to configure this.

getHandlerElement

public IElement getHandlerElement()

The IElement that was used configured to be forwarded to a ICodeExitHandler.

Returns:

The IElement that was used configured to be forwarded to a handler.

getIconName

public String getIconName()

Description copied from interface: IPresentationSupport

A name for an icon.

Specified by:

getIconName in interface IPresentationSupport

Returns:

A name for an icon.

getLabel

public String getLabel()

Description copied from interface: IPresentationSupport

A short string representation (suitable for example for use with an icon or menu item).

Specified by:

getLabel in interface IPresentationSupport

Returns:

A short string representation (suitable for example for use with an icon or menu item).

getName

public String getName()

getOwner

public Object getOwner()

A generic link to an object that is the "owner" of this.

Returns:

A generic link to an object that is the "owner" of this.

getSource

public String getSource()

The source code.

Returns:

The source code.

getSourceExpanded

public String getSourceExpanded(IArgs args)

getTip

public String getTip()

Description copied from interface: IPresentationSupport

An "intermediate" length description (suitable for example with a tooltip).

Specified by:

getTip in interface IPresentationSupport

Returns:

An "intermediate" length description (suitable for example with a tooltip).

getType

public String getType()

The type. This token selects under a variety of ICodeExitHandler instances to support different implementation languages.

Returns:

The type.

isDefinedSource

public boolean isDefinedSource()

isDefinedType

public boolean isDefinedType()

perform

public T perform(IFunctorCall call)
          throws FunctorInvocationException

Description copied from interface: IFunctor

Perform the encapsulated business logic in the context defined in "call".

Specified by:

perform in interface IFunctor<T>

Parameters:

call - The call context

Returns:

The behavior execution result.

Throws:

FunctorInvocationException - An exception that raised while executing the business logic will be wrapped in a FunctorInvocationException.

serialize

public void serialize(IElement element)
               throws ElementSerializationException

Description copied from interface: IElementSerializable

Serialize the state in element. element represents the receiver immediately, it contains the state information directly, not as a child element. This means most of the time you have to change the element name itself and add child elements.

Specified by:

serialize in interface IElementSerializable

Throws:

ElementSerializationException

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Set the ClassLoader to be used with this CodeExit. This should be the ClassLoader instance that would give access to all resources needed by the CodeExit's business logic implementation.

Specified by:

setClassLoader in interface IClassLoaderAccess

Parameters:

classLoader - The ClassLoader to be used to access the resources needed by the CodeExit's business logic implementation.

setCompiledSource

public void setCompiledSource(Object compiledSource)

setName

public void setName(String name)

setOwner

public void setOwner(Object owner)

Set an owner for the CodeExit.

This should be used in conjunction with the no-arg constructor in reflective programming only.

Parameters:

owner -

setSource

public void setSource(String value)

Assign the source.

Parameters:

value - The source string.

setType

public void setType(String type)

Assign the type.

Parameters:

type - The type string.