org.x4o.xml.lang.phase

Interface X4OPhase

All Known Implementing Classes:

AbstractX4OPhase

public interface X4OPhase

X4OPhase is one small step in the read or write process of the language.

Version:

1.0 Dec 31, 2008

Author:

Willem Cazander

Method Summary

Methods

Modifier and Type	Method and Description
void	addPhaseListener(X4OPhaseListener listener) Adds an X4OPhaseListener.
String	getId() Returns the X4OPhase for which this handler was written.
String[]	getPhaseDependencies()
List<X4OPhaseListener>	getPhaseListeners() Returns all phase listeners which where added.
X4OPhaseType	getType()
boolean	isElementPhase() runPhase is called but should do nothig.
boolean	isRunOnce() Returns a flag indicating that this phase is runnable multiple times.
void	removePhaseListener(X4OPhaseListener listener) Removes an X4OPhaseListener.
void	runElementPhase(Element element) Run this phase for this Element.
void	runPhase(X4OLanguageContext elementLanguage) Runs this phase.

Method Detail

getType

X4OPhaseType getType()

getId

String getId()

Returns the X4OPhase for which this handler was written.

Returns:

Returns the phase for which this handler works.

getPhaseDependencies

String[] getPhaseDependencies()

isRunOnce

boolean isRunOnce()

Returns a flag indicating that this phase is runnable multiple times.

Returns:

True if phase is restricted to run once.

runPhase

void runPhase(X4OLanguageContext elementLanguage)
              throws X4OPhaseException

Runs this phase.

Parameters:

elementLanguage - The elementLanguage running this phase.

Throws:

X4OPhaseException - When error has happend.

getPhaseListeners

List<X4OPhaseListener> getPhaseListeners()

Returns all phase listeners which where added.

Returns:

All X4OPhaseListeners.

addPhaseListener

void addPhaseListener(X4OPhaseListener listener)

Adds an X4OPhaseListener.

Parameters:

listener - The listener to add.

removePhaseListener

void removePhaseListener(X4OPhaseListener listener)

Removes an X4OPhaseListener.

Parameters:

listener - The listener to remove.

isElementPhase

boolean isElementPhase()

runPhase is called but should do nothig. When elementPhase is enables x4o tries to merge all element phases so we don't need to loop element tree to often.

Returns:

True if to run in config.

runElementPhase

void runElementPhase(Element element)
                     throws X4OPhaseException

Run this phase for this Element.

Parameters:

element - The element to run this phase for.

Throws:

X4OPhaseException - Is thrown when error has happen.