Class AbstractX4OPhase

java.lang.Object

org.x4o.xml.lang.phase.AbstractX4OPhase

All Implemented Interfaces:

X4OPhase

Direct Known Subclasses:

X4OPhaseLanguageInit.X4OPhaseInitLanguageSiblings

public abstract class AbstractX4OPhase
extends Object
implements X4OPhase

AbstractX4OPhaseHandler a base class for creating a phase handler.

Version:

1.0 Dec 31, 2008

Author:

Willem Cazander

Field Summary

Fields

Modifier and Type	Field	Description
protected List<X4OPhaseListener>	phaseListeners

Constructor Summary

Constructors

Constructor	Description
AbstractX4OPhase()	Creates the AbstractX4OPhaseHandler.

Method Summary

Modifier and Type	Method	Description
void	addPhaseListener(X4OPhaseListener listener)	Adds a phase listener.
List<X4OPhaseListener>	getPhaseListeners()	Gets the phase listeners.
boolean	isElementPhase()	If returns true then this handler will run on all elements.
boolean	isRunOnce()	defaults to false
void	removePhaseListener(X4OPhaseListener listener)	Removed a phase listener.
abstract void	runElementPhase(Element element)	Abstract method.
void	runPhase(X4OLanguageSession elementLanguage)	Empty method.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.x4o.xml.lang.phase.X4OPhase

getId, getPhaseDependencies, getType

Field Details

phaseListeners

protected List<X4OPhaseListener> phaseListeners

Constructor Details

AbstractX4OPhase

public AbstractX4OPhase()

Creates the AbstractX4OPhaseHandler.

Method Details

isRunOnce

public boolean isRunOnce()

defaults to false

Specified by:

isRunOnce in interface X4OPhase

Returns:

True if phase is restricted to run once.

getPhaseListeners

public List<X4OPhaseListener> getPhaseListeners()

Gets the phase listeners.

Specified by:

getPhaseListeners in interface X4OPhase

Returns:

The x4o phase listeners.

addPhaseListener

public void addPhaseListener(X4OPhaseListener listener)

Adds a phase listener.

Specified by:

addPhaseListener in interface X4OPhase

Parameters:

listener - The phase listener to add.

removePhaseListener

public void removePhaseListener(X4OPhaseListener listener)

Removed a phase listener.

Specified by:

removePhaseListener in interface X4OPhase

Parameters:

listener - The phase listener to remove.

isElementPhase

public boolean isElementPhase()

If returns true then this handler will run on all elements.

Specified by:

isElementPhase in interface X4OPhase

Returns:

defaults to true.

runElementPhase

public abstract void runElementPhase(Element element)
                              throws X4OPhaseException

Abstract method.

Specified by:

runElementPhase in interface X4OPhase

Parameters:

element - The element to run phase for.

Throws:

X4OPhaseException - when phase has error.

runPhase

public void runPhase(X4OLanguageSession elementLanguage)
              throws X4OPhaseException

Empty method.

Specified by:

runPhase in interface X4OPhase

Parameters:

elementLanguage - The language to run phase for.

Throws:

X4OPhaseException - when phase has error.