aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.bind;
aoqi@0: 
aoqi@0: import javax.xml.bind.Marshaller;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Optional interface that can be implemented by JAXB-bound objects
aoqi@0:  * to handle cycles in the object graph.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * As discussed in <a href="https://jaxb.dev.java.net/guide/Mapping_cyclic_references_to_XML.html">
aoqi@0:  * the users' guide</a>, normally a cycle in the object graph causes the marshaller to report an error,
aoqi@0:  * and when an error is found, the JAXB RI recovers by cutting the cycle arbitrarily.
aoqi@0:  * This is not always a desired behavior.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * Implementing this interface allows user application to change this behavior.
aoqi@0:  * Also see <a href="http://forums.java.net/jive/thread.jspa?threadID=13670">this related discussion</a>.
aoqi@0:  *
aoqi@0:  * @since JAXB 2.1 EA2
aoqi@0:  * @author Kohsuke Kawaguchi
aoqi@0:  */
aoqi@0: public interface CycleRecoverable {
aoqi@0:     /**
aoqi@0:      * Called when a cycle is detected by the JAXB RI marshaller
aoqi@0:      * to nominate a new object to be marshalled instead.
aoqi@0:      *
aoqi@0:      * @param context
aoqi@0:      *      This object is provided by the JAXB RI to inform
aoqi@0:      *      the object about the marshalling process that's going on.
aoqi@0:      *
aoqi@0:      *
aoqi@0:      * @return
aoqi@0:      *      the object to be marshalled instead of <tt>this</tt> object.
aoqi@0:      *      Or return null to indicate that the JAXB RI should behave
aoqi@0:      *      just like when your object does not implement {@link CycleRecoverable}
aoqi@0:      *      (IOW, cut the cycle arbitrarily and try to go on.)
aoqi@0:      */
aoqi@0:     Object onCycleDetected(Context context);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * This interface is implemented by the JAXB RI to provide
aoqi@0:      * information about the on-going marshalling process.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * We may add more methods in the future, so please do not
aoqi@0:      * implement this interface in your application.
aoqi@0:      */
aoqi@0:     public interface Context {
aoqi@0:         /**
aoqi@0:          * Returns the marshaller object that's doing the marshalling.
aoqi@0:          *
aoqi@0:          * @return
aoqi@0:          *      always non-null.
aoqi@0:          */
aoqi@0:         Marshaller getMarshaller();
aoqi@0:     }
aoqi@0: }