org.x4o.xml.core

Class AbstractX4OPhaseHandler

java.lang.Object

org.x4o.xml.core.AbstractX4OPhaseHandler

All Implemented Interfaces:

X4OPhaseHandler

public abstract class AbstractX4OPhaseHandler
extends Object
implements X4OPhaseHandler

An base class for creating X4OPhaseHandlers.

Version:

1.0 Dec 31, 2008

Author:

Willem Cazander

Field Summary

Fields

Modifier and Type	Field and Description
protected X4OPhase	phase
protected List<X4OPhaseListener>	X4OPhaseListeners

Constructor Summary

Constructors

Constructor and Description
AbstractX4OPhaseHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	addPhaseListener(X4OPhaseListener listener) Adds an X4OPhaseListener
X4OPhase	getX4OPhase() Returns the X4OPhase for which this handler was written.
List<X4OPhaseListener>	getX4OPhaseListeners() Returns all X4OPhaseListeners which where added.
boolean	isElementPhase() runPhase is called but should do nothig.
void	removePhaseListener(X4OPhaseListener listener) Removes an X4OPhaseListener
abstract void	runElementPhase(Element element) Run this phase for this Element.
void	runPhase(ElementLanguage elementLanguage) Runs this phase.
protected abstract void	setX4OPhase() Is called from constuctor

Methods inherited from class java.lang.Object

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

Field Detail

phase

protected X4OPhase phase

X4OPhaseListeners

protected List<X4OPhaseListener> X4OPhaseListeners

Constructor Detail

AbstractX4OPhaseHandler

public AbstractX4OPhaseHandler()

Method Detail

setX4OPhase

protected abstract void setX4OPhase()

Is called from constuctor

getX4OPhase

public X4OPhase getX4OPhase()

Description copied from interface: X4OPhaseHandler

Returns the X4OPhase for which this handler was written.

Specified by:

getX4OPhase in interface X4OPhaseHandler

Returns:

Returns the phase for which this handler works.

getX4OPhaseListeners

public List<X4OPhaseListener> getX4OPhaseListeners()

Description copied from interface: X4OPhaseHandler

Returns all X4OPhaseListeners which where added.

Specified by:

getX4OPhaseListeners in interface X4OPhaseHandler

Returns:

All X4OPhaseListeners.

addPhaseListener

public void addPhaseListener(X4OPhaseListener listener)

Description copied from interface: X4OPhaseHandler

Adds an X4OPhaseListener

Specified by:

addPhaseListener in interface X4OPhaseHandler

removePhaseListener

public void removePhaseListener(X4OPhaseListener listener)

Description copied from interface: X4OPhaseHandler

Removes an X4OPhaseListener

Specified by:

removePhaseListener in interface X4OPhaseHandler

isElementPhase

public boolean isElementPhase()

Description copied from interface: X4OPhaseHandler

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.

Specified by:

isElementPhase in interface X4OPhaseHandler

Returns:

True if to run in config.

runElementPhase

public abstract void runElementPhase(Element element)
                              throws X4OPhaseException

Description copied from interface: X4OPhaseHandler

Run this phase for this Element.

Specified by:

runElementPhase in interface X4OPhaseHandler

Throws:

X4OPhaseException

runPhase

public void runPhase(ElementLanguage elementLanguage)
              throws X4OPhaseException

Description copied from interface: X4OPhaseHandler

Runs this phase.

Specified by:

runPhase in interface X4OPhaseHandler

Throws:

X4OPhaseException