01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.xml.bind;
38:
39: import javax.xml.bind.Marshaller;
40:
41: /**
42: * Optional interface that can be implemented by JAXB-bound objects
43: * to handle cycles in the object graph.
44: *
45: * <p>
46: * As discussed in <a href="https://jaxb.dev.java.net/guide/Mapping_cyclic_references_to_XML.html">
47: * the users' guide</a>, normally a cycle in the object graph causes the marshaller to report an error,
48: * and when an error is found, the JAXB RI recovers by cutting the cycle arbitrarily.
49: * This is not always a desired behavior.
50: *
51: * <p>
52: * Implementing this interface allows user application to change this behavior.
53: * Also see <a href="http://forums.java.net/jive/thread.jspa?threadID=13670">this related discussion</a>.
54: *
55: * @since JAXB 2.1 EA2
56: * @author Kohsuke Kawaguchi
57: */
58: public interface CycleRecoverable {
59: /**
60: * Called when a cycle is detected by the JAXB RI marshaller
61: * to nominate a new object to be marshalled instead.
62: *
63: * @param context
64: * This object is provided by the JAXB RI to inform
65: * the object about the marshalling process that's going on.
66: *
67: *
68: * @return
69: * the object to be marshalled instead of <tt>this</tt> object.
70: * Or return null to indicate that the JAXB RI should behave
71: * just like when your object does not implement {@link CycleRecoverable}
72: * (IOW, cut the cycle arbitrarily and try to go on.)
73: */
74: Object onCycleDetected(Context context);
75:
76: /**
77: * This interface is implemented by the JAXB RI to provide
78: * information about the on-going marshalling process.
79: *
80: * <p>
81: * We may add more methods in the future, so please do not
82: * implement this interface in your application.
83: */
84: public interface Context {
85: /**
86: * Returns the marshaller object that's doing the marshalling.
87: *
88: * @return
89: * always non-null.
90: */
91: Marshaller getMarshaller();
92: }
93: }
|