org.xwiki.rendering.transformation
Class AbstractTransformation

java.lang.Object
  org.xwiki.rendering.transformation.AbstractTransformation

All Implemented Interfaces:

Comparable<Transformation>, Transformation

public abstract class AbstractTransformation
extends Object
implements Transformation

Code common to all Transformation and base implementation of priorities (see Transformation.getPriority()).

Since:

1.5M2

Version:

$Id$

Constructor Summary

AbstractTransformation()

Method Summary

int	compareTo(Transformation transformation)
int	getPriority() The priority of execution relative to the other transformations.
void	transform(XDOM dom, Syntax syntax) Transform the passed XDOM and modifies it.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xwiki.rendering.transformation.Transformation

transform

Constructor Detail

AbstractTransformation

public AbstractTransformation()

Method Detail

getPriority

public int getPriority()

Description copied from interface: Transformation

The priority of execution relative to the other transformations. The lowest values have the highest priorities and execute first. For example a Transformation with a priority of 100 will execute before one with a priority of 500.

Specified by:

getPriority in interface Transformation

Returns:

the execution priority

compareTo

public int compareTo(Transformation transformation)

Specified by:

compareTo in interface Comparable<Transformation>

transform

public void transform(XDOM dom,
                      Syntax syntax)
               throws TransformationException

Description copied from interface: Transformation

Transform the passed XDOM and modifies it.

Specified by:

transform in interface Transformation

Parameters:

dom - the AST representing the content in Blocks

syntax - the Syntax of the content

Throws:

TransformationException - if the transformation fails for any reason