1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/jaxws_classes/com/sun/xml/internal/bind/CycleRecoverable.java Wed Apr 27 01:27:09 2016 +0800
1.3 @@ -0,0 +1,82 @@
1.4 +/*
1.5 + * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package com.sun.xml.internal.bind;
1.30 +
1.31 +import javax.xml.bind.Marshaller;
1.32 +
1.33 +/**
1.34 + * Optional interface that can be implemented by JAXB-bound objects
1.35 + * to handle cycles in the object graph.
1.36 + *
1.37 + * <p>
1.38 + * As discussed in <a href="https://jaxb.dev.java.net/guide/Mapping_cyclic_references_to_XML.html">
1.39 + * the users' guide</a>, normally a cycle in the object graph causes the marshaller to report an error,
1.40 + * and when an error is found, the JAXB RI recovers by cutting the cycle arbitrarily.
1.41 + * This is not always a desired behavior.
1.42 + *
1.43 + * <p>
1.44 + * Implementing this interface allows user application to change this behavior.
1.45 + * Also see <a href="http://forums.java.net/jive/thread.jspa?threadID=13670">this related discussion</a>.
1.46 + *
1.47 + * @since JAXB 2.1 EA2
1.48 + * @author Kohsuke Kawaguchi
1.49 + */
1.50 +public interface CycleRecoverable {
1.51 + /**
1.52 + * Called when a cycle is detected by the JAXB RI marshaller
1.53 + * to nominate a new object to be marshalled instead.
1.54 + *
1.55 + * @param context
1.56 + * This object is provided by the JAXB RI to inform
1.57 + * the object about the marshalling process that's going on.
1.58 + *
1.59 + *
1.60 + * @return
1.61 + * the object to be marshalled instead of <tt>this</tt> object.
1.62 + * Or return null to indicate that the JAXB RI should behave
1.63 + * just like when your object does not implement {@link CycleRecoverable}
1.64 + * (IOW, cut the cycle arbitrarily and try to go on.)
1.65 + */
1.66 + Object onCycleDetected(Context context);
1.67 +
1.68 + /**
1.69 + * This interface is implemented by the JAXB RI to provide
1.70 + * information about the on-going marshalling process.
1.71 + *
1.72 + * <p>
1.73 + * We may add more methods in the future, so please do not
1.74 + * implement this interface in your application.
1.75 + */
1.76 + public interface Context {
1.77 + /**
1.78 + * Returns the marshaller object that's doing the marshalling.
1.79 + *
1.80 + * @return
1.81 + * always non-null.
1.82 + */
1.83 + Marshaller getMarshaller();
1.84 + }
1.85 +}
