org.xwiki.velocity.internal.util
Class VelocityParserContext

java.lang.Object
  org.xwiki.velocity.internal.util.VelocityParserContext

public class VelocityParserContext
extends java.lang.Object

Provided to VelocityParser helpers to return some information.

Version:

$Id$

Constructor Summary

VelocityParserContext()

Method Summary

VelocityBlock	getCurrentElement()
VelocityBlock.VelocityType	getType()
boolean	isInVelocityBlock()
VelocityBlock	popVelocityElement() Go out of a Velocity block.
VelocityBlock	pushVelocityElement(VelocityBlock block) Enter a Velocity block.
void	setType(VelocityBlock.VelocityType type)

Methods inherited from class java.lang.Object

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

Constructor Detail

VelocityParserContext

public VelocityParserContext()

Method Detail

setType

public void setType(VelocityBlock.VelocityType type)

Parameters:

type - the type of found velocity block.

getType

public VelocityBlock.VelocityType getType()

Returns:

The type of found velocity block.

getCurrentElement

public VelocityBlock getCurrentElement()

Returns:

the Velocity block in which the process is.

pushVelocityElement

public VelocityBlock pushVelocityElement(VelocityBlock block)

Enter a Velocity block.

Parameters:

block - the Velocity block in which the process is.

Returns:

the Velocity block in which the process is.

popVelocityElement

public VelocityBlock popVelocityElement()

Go out of a Velocity block.

Returns:

the previous Velocity block in which the process was.

isInVelocityBlock

public boolean isInVelocityBlock()

Returns:

indicate if the current process is inside a Velocity block.