EclipseLink/Release/2.4.0/JAXB RI Extensions/Cycle Recoverable

From Eclipsepedia

Jump to: navigation, search

Design Documentation: CycleRecoverable

ER 372404

In the current JAXB RI, developed by Sun, there are a series of "proprietary" JAXB extensions that are available to provide advanced JAXB functionality outside of the JAXB spec (these extension classes reside in the com.sun.xml.bind package).

The CycleRecoverable interface allows the user to write their own logic to be used when object cycles are detected during marshal operations. When a cycle is detected, MOXy will invoke the onCycleDetected, which returns a "replacement" object for the one that caused the cycle.

This document will outline the design for an EclipseLink equivalent to this extension.


Consider the following two classes:

import java.util.*;
import javax.xml.bind.annotation.*;
public class Department {
   public String name;
   public List<Employee> employees = new ArrayList<Employee>();
public class Employee {
   public String name;
   public Department dept;

An object cycle would be created if you constructed the following objects:

Employee emp1 = new Employee(); = "Fred Smith";
Department dept1 = new Department(); = "Accounting";
emp1.dept = dept1;
jaxbContext.createMarshaller().marshal(dept1, System.out);
// This will result in the following error:
// A cycle is detected in the object graph.  This will cause an infinite loop: 
// Department@122cdb6 -> Employee@1ef9157 -> Department@122cdb6