de.intarsys.tools.macro

Class MacroReturn

java.lang.Object

de.intarsys.tools.macro.MacroFunctor

de.intarsys.tools.macro.MacroReturn

All Implemented Interfaces:

IContextSupport, IFunctor, IElementConfigurable, IElementSerializable, IPresentationSupport, IClassLoaderSupport

public class MacroReturn
extends MacroFunctor

Return from the execution of a MacroBlock, regardless of execution depth. The result of this service is the result of the "value" expression executed or null.

Field Summary

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

ATTR_DESCRIPTION, ATTR_ICON, ATTR_LABEL, ATTR_TIP

Constructor Summary

Constructors

Constructor and Description
MacroReturn()
MacroReturn(IFunctor expr)

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(IElement element)
String	getLabel() A short string representation (suitable for example for use with an icon or menu item).
IFunctor	getValueExpression()
Object	perform(IFunctorCall call) Perform the encapsulated business logic in the context defined in "call".
void	serialize(IElement element) Serialize the state in element.
void	setContext(Object context)
void	setValueExpression(IFunctor step)

Methods inherited from class de.intarsys.tools.macro.MacroFunctor

getClassLoader, getContainer, getContext, getDescription, getIconName, getTip, setContainer

Methods inherited from class java.lang.Object

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

Constructor Detail

MacroReturn

public MacroReturn()

MacroReturn

public MacroReturn(IFunctor expr)

Method Detail

configure

public void configure(IElement element)
               throws ConfigurationException

Specified by:

configure in interface IElementConfigurable

Overrides:

configure in class MacroFunctor

Throws:

ConfigurationException

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

Overrides:

getLabel in class MacroFunctor

Returns:

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

getValueExpression

public IFunctor getValueExpression()

perform

public Object perform(IFunctorCall call)
               throws FunctorInvocationException

Description copied from interface: IFunctor

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

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

Overrides:

serialize in class MacroFunctor

Throws:

ElementSerializationException

setContext

public void setContext(Object context)
                throws ConfigurationException

Specified by:

setContext in interface IContextSupport

Overrides:

setContext in class MacroFunctor

Throws:

ConfigurationException

setValueExpression

public void setValueExpression(IFunctor step)