Package org.dom4j.io

Class ElementStack

java.lang.Object

org.dom4j.io.ElementStack

All Implemented Interfaces:

ElementPath

Direct Known Subclasses:

PruningElementStack

class ElementStack
extends Object
implements ElementPath

ElementStack is used internally inside the SAXContentHandler to maintain a stack of Elementinstances. It opens an integration possibility allowing derivations to prune the tree when a node is complete.

Version:

$Revision: 1.14 $

Author:

James Strachan

Field Summary

Fields

Modifier and Type	Field	Description
protected int	lastElementIndex	index of the item at the top of the stack or -1 if the stack is empty
protected Element[]	stack	stack of Element objects

Constructor Summary

Constructors

Constructor	Description
ElementStack()
ElementStack(int defaultCapacity)

Method Summary

Modifier and Type	Method	Description
void	addHandler(String path, ElementHandler elementHandler)	Adds the ElementHandler to be called when the specified path is encounted.
void	clear()	Peeks at the top element on the stack without changing the contents of the stack.
boolean	containsHandler(String path)	DOCUMENT ME!
Element	getCurrent()	DOCUMENT ME!
DispatchHandler	getDispatchHandler()
Element	getElement(int depth)	DOCUMENT ME!
String	getPath()	DOCUMENT ME!
Element	peekElement()	Peeks at the top element on the stack without changing the contents of the stack.
Element	popElement()	Pops the element off the stack
void	pushElement(Element element)	Pushes a new element onto the stack
protected void	reallocate(int size)	Reallocates the stack to the given size
void	removeHandler(String path)	Removes the ElementHandler from the event based processor, for the specified path.
void	setDispatchHandler(DispatchHandler dispatchHandler)
int	size()	DOCUMENT ME!

Methods inherited from class java.lang.Object

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

Field Detail

stack

protected Element[] stack

stack of Element objects

lastElementIndex

protected int lastElementIndex

index of the item at the top of the stack or -1 if the stack is empty

Constructor Detail

ElementStack

public ElementStack()

ElementStack

public ElementStack(int defaultCapacity)

Method Detail

setDispatchHandler

public void setDispatchHandler(DispatchHandler dispatchHandler)

getDispatchHandler

public DispatchHandler getDispatchHandler()

clear

public void clear()

Peeks at the top element on the stack without changing the contents of the stack.

peekElement

public Element peekElement()

Peeks at the top element on the stack without changing the contents of the stack.

Returns:

the current element on the stack

popElement

public Element popElement()

Pops the element off the stack

Returns:

the element that has just been popped off the stack

pushElement

public void pushElement(Element element)

Pushes a new element onto the stack

Parameters:

element - DOCUMENT ME!

reallocate

protected void reallocate(int size)

Reallocates the stack to the given size

Parameters:

size - DOCUMENT ME!

size

public int size()

Description copied from interface: ElementPath

DOCUMENT ME!

Specified by:

size in interface ElementPath

Returns:

the number of elements in the path

getElement

public Element getElement(int depth)

Description copied from interface: ElementPath

DOCUMENT ME!

Specified by:

getElement in interface ElementPath

Parameters:

depth - DOCUMENT ME!

Returns:

the element at the specified depth index, 0 = root element

getPath

public String getPath()

Description copied from interface: ElementPath

DOCUMENT ME!

Specified by:

getPath in interface ElementPath

Returns:

the path as a string

getCurrent

public Element getCurrent()

Description copied from interface: ElementPath

DOCUMENT ME!

Specified by:

getCurrent in interface ElementPath

Returns:

the current element

addHandler

public void addHandler(String path,
                       ElementHandler elementHandler)

Description copied from interface: ElementPath

Adds the ElementHandler to be called when the specified path is encounted. The path can be either an absolute path (i.e. prefixed with "/") or a relative path (i.e. assummed to be a child of the current path as retrieved by getPath .

Specified by:

addHandler in interface ElementPath

Parameters:

path - is the path to be handled

elementHandler - is the ElementHandler to be called by the event based processor.

removeHandler

public void removeHandler(String path)

Description copied from interface: ElementPath

Removes the ElementHandler from the event based processor, for the specified path. The path can be either an absolute path (i.e. prefixed with "/") or a relative path (i.e. assummed to be a child of the current path as retrieved by getPath .

Specified by:

removeHandler in interface ElementPath

Parameters:

path - is the path to remove the ElementHandler for.

containsHandler

public boolean containsHandler(String path)

DOCUMENT ME!

Parameters:

path - DOCUMENT ME!

Returns:

true when an ElementHandler is registered for the specified path.