|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.jcr.util.TraversingItemVisitor
public abstract class TraversingItemVisitor
An implementation of ItemVisitor
.
TraversingItemVisitor
is an abstract utility class which allows
to easily traverse an Item
hierarchy.
TraversingItemVisitor
makes use of the Visitor Pattern as
described in the book 'Design Patterns' by the Gang Of Four (Gamma et al.).
Tree traversal is done observing the left-to-right order of child
Item
s if such an order is supported and exists.
Nested Class Summary | |
---|---|
static class |
TraversingItemVisitor.Default
Convenience class providing default implementations of the abstract methods of TraversingItemVisitor . |
Constructor Summary | |
---|---|
TraversingItemVisitor()
Constructs a new instance of this class. |
|
TraversingItemVisitor(boolean breadthFirst)
Constructs a new instance of this class. |
|
TraversingItemVisitor(boolean breadthFirst,
int maxLevel)
Constructs a new instance of this class. |
Method Summary | |
---|---|
void |
visit(Node node)
Called when the Visitor is passed to a Node . |
void |
visit(Property property)
Called when the Visitor is passed to a
Property . |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TraversingItemVisitor()
The tree of Item
s will be traversed in a depth-first manner
(default behavior).
public TraversingItemVisitor(boolean breadthFirst)
breadthFirst
- if breadthFirst
is true then traversal
is done in a breadth-first manner; otherwise it is done in a depth-first
manner (which is the default behavior).public TraversingItemVisitor(boolean breadthFirst, int maxLevel)
breadthFirst
- if breadthFirst
is true then traversal
is done in a breadth-first manner; otherwise it is done in a depth-first
manner (which is the default behavior).maxLevel
- the 0-based level up to which the hierarchy should be
traversed (if it's -1, the hierarchy will be traversed until there are no
more children of the current item).Method Detail |
---|
public void visit(Property property) throws RepositoryException
Visitor
is passed to a
Property
.
It calls TraversingItemVisitor.entering(Property, int)
followed by TraversingItemVisitor.leaving(Property, int)
.
Implement these abstract methods to specify behavior on 'arrival at' and
'after leaving' the Property
.
If this method throws, the visiting process is aborted.
visit
in interface ItemVisitor
property
- the Property
that is accepting this
visitor.
RepositoryException
- if an error occurs.public void visit(Node node) throws RepositoryException
Visitor
is passed to a Node
.
It calls TraversingItemVisitor.entering(Node, int)
followed
by TraversingItemVisitor.leaving(Node, int)
. Implement these
abstract methods to specify behavior on 'arrival at' and 'after leaving'
the Node
.
If this method throws, the visiting process is aborted.
visit
in interface ItemVisitor
node
- the Node
that is accepting this visitor.
RepositoryException
- if an error occurs.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |