hu.elte.eserial.recursion

Class RecursionChecker

java.lang.Object

hu.elte.eserial.recursion.RecursionChecker

public class RecursionChecker
extends java.lang.Object

Simple class to check for recursion while serializing an object.
Usage:

1. While recursively visiting the object's elements, before each step the beforeVisit(hu.elte.eserial.model.EserialElement) should be called with the element to visit.
2. After this call, the canVisit(hu.elte.eserial.model.EserialElement) tells whether this element is allowed to be visited.
3. After the visit, the afterVisit(hu.elte.eserial.model.EserialElement) should be called to signal the end of the visit.

Constructor Summary

Constructors

Constructor and Description
RecursionChecker(java.lang.Object root)

Method Summary

Modifier and Type	Method and Description
void	afterVisit(EserialElement element) Removes the element and all of its children from the recursion checking.
void	beforeVisit(EserialElement element) Saves the element for later checking of possible recursions.
boolean	canVisit(EserialElement element)

Methods inherited from class java.lang.Object

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

Constructor Detail

RecursionChecker

public RecursionChecker(java.lang.Object root)

Method Detail

canVisit

public boolean canVisit(EserialElement element)

Parameters:

element - the element to check before visiting it

Returns:

true if the element has not already been visited and it's not the root of the map.

beforeVisit

public void beforeVisit(EserialElement element)

Saves the element for later checking of possible recursions.

Parameters:

element - the element to be visited

afterVisit

public void afterVisit(EserialElement element)

Removes the element and all of its children from the recursion checking.

Parameters:

element - the element that has been visited