de.intarsys.tools.macro

Class MacroBlock

java.lang.Object

de.intarsys.tools.macro.MacroFunctor

de.intarsys.tools.macro.MacroBlock

All Implemented Interfaces:

IContextSupport, IFunctor, IElementConfigurable, IElementSerializable, IPresentationSupport, IClassLoaderSupport

public class MacroBlock
extends MacroFunctor

The MacroBlock allows for aggregation of other IFunctor instances to a new compound implementation. Each IFunctor expression is called in the order of definition. The result of the MacroBlock is the result of the last expression. The result is undefined when an error was thrown and not handled. If an error occurs, normal execution is terminated and all error expressions are executed if available. The error execution may handle the error or rethrow another. If an error occurs while executing the error expressions, the execution is terminated and the error is thrown. If no error expressions are defined, the error is thrown. After normal execution or error execution is finished, all finally expressions are performed. If an error occurs while executing the finally expressions, the finally execution is terminated and the error is thrown. To ensure that all finally blocks are properly executed, each block implementation should take care of defensive exception handling.

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
MacroBlock()

Method Summary

Methods

Modifier and Type	Method and Description
void	addBlockExpression(IFunctor step)
void	addBlockExpression(int index, IFunctor step)
void	addErrorExpression(IFunctor step)
void	addErrorExpression(int index, IFunctor step)
void	addFinallyExpression(IFunctor step)
void	addFinallyExpression(int index, IFunctor step)
void	configure(IElement element)
List<IFunctor>	getBlockExpressions()
List<IFunctor>	getErrorExpressions()
List<IFunctor>	getFinallyExpressions()
String	getLabel() A short string representation (suitable for example for use with an icon or menu item).
Object	perform(IFunctorCall call) Perform the encapsulated business logic in the context defined in "call".
void	removeBlockExpression(IFunctor step)
void	removeErrorExpression(IFunctor step)
void	removeFinallyExpression(IFunctor step)
void	serialize(IElement element) Serialize the state in element.
void	setContext(Object context)

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

MacroBlock

public MacroBlock()

Method Detail

addBlockExpression

public void addBlockExpression(IFunctor step)

addBlockExpression

public void addBlockExpression(int index,
                      IFunctor step)

addErrorExpression

public void addErrorExpression(IFunctor step)

addErrorExpression

public void addErrorExpression(int index,
                      IFunctor step)

addFinallyExpression

public void addFinallyExpression(IFunctor step)

addFinallyExpression

public void addFinallyExpression(int index,
                        IFunctor step)

configure

public void configure(IElement element)
               throws ConfigurationException

Specified by:

configure in interface IElementConfigurable

Overrides:

configure in class MacroFunctor

Throws:

ConfigurationException

getBlockExpressions

public List<IFunctor> getBlockExpressions()

getErrorExpressions

public List<IFunctor> getErrorExpressions()

getFinallyExpressions

public List<IFunctor> getFinallyExpressions()

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).

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.

removeBlockExpression

public void removeBlockExpression(IFunctor step)

removeErrorExpression

public void removeErrorExpression(IFunctor step)

removeFinallyExpression

public void removeFinallyExpression(IFunctor step)

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