Package com.xwiki.commons.document

Class MacroFindBreakException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.xwiki.commons.document.MacroFindBreakException

All Implemented Interfaces:

Serializable

public class MacroFindBreakException
extends Exception

Exception that can be used by the MacroBlockFinder when the MacroBlockFinder.Lookup that gets returned is BREAK. This can be useful when searching recursively and you want the execution to halt.

Since:

1.4.0

Version:

$Id$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
MacroFindBreakException(org.xwiki.rendering.block.XDOM xdom)	Creates an instance that holds a reference to the XDOM at the point where the execution halted.

Method Summary

Modifier and Type	Method	Description
org.xwiki.rendering.block.XDOM	getXdom()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MacroFindBreakException

public MacroFindBreakException(org.xwiki.rendering.block.XDOM xdom)

Creates an instance that holds a reference to the XDOM at the point where the execution halted.

Parameters:

xdom - the reference to the XDOM at the point of breaking the execution.

Method Detail

getXdom

public org.xwiki.rendering.block.XDOM getXdom()

Returns:

a reference to the XDOM that was being searched through.