Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/bind/CycleRecoverable.java@e530533619ec (annotated)
src/share/jaxws_classes/com/sun/xml/internal/bind/CycleRecoverable.java
Thu, 12 Oct 2017 19:44:07 +0800
- author
- aoqi
- date
- Thu, 12 Oct 2017 19:44:07 +0800
- changeset 760
- e530533619ec
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package com.sun.xml.internal.bind; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import javax.xml.bind.Marshaller; |
| aoqi@0 | 29 | |
| aoqi@0 | 30 | /** |
| aoqi@0 | 31 | * Optional interface that can be implemented by JAXB-bound objects |
| aoqi@0 | 32 | * to handle cycles in the object graph. |
| aoqi@0 | 33 | * |
| aoqi@0 | 34 | * <p> |
| aoqi@0 | 35 | * As discussed in <a href="https://jaxb.dev.java.net/guide/Mapping_cyclic_references_to_XML.html"> |
| aoqi@0 | 36 | * the users' guide</a>, normally a cycle in the object graph causes the marshaller to report an error, |
| aoqi@0 | 37 | * and when an error is found, the JAXB RI recovers by cutting the cycle arbitrarily. |
| aoqi@0 | 38 | * This is not always a desired behavior. |
| aoqi@0 | 39 | * |
| aoqi@0 | 40 | * <p> |
| aoqi@0 | 41 | * Implementing this interface allows user application to change this behavior. |
| aoqi@0 | 42 | * Also see <a href="http://forums.java.net/jive/thread.jspa?threadID=13670">this related discussion</a>. |
| aoqi@0 | 43 | * |
| aoqi@0 | 44 | * @since JAXB 2.1 EA2 |
| aoqi@0 | 45 | * @author Kohsuke Kawaguchi |
| aoqi@0 | 46 | */ |
| aoqi@0 | 47 | public interface CycleRecoverable { |
| aoqi@0 | 48 | /** |
| aoqi@0 | 49 | * Called when a cycle is detected by the JAXB RI marshaller |
| aoqi@0 | 50 | * to nominate a new object to be marshalled instead. |
| aoqi@0 | 51 | * |
| aoqi@0 | 52 | * @param context |
| aoqi@0 | 53 | * This object is provided by the JAXB RI to inform |
| aoqi@0 | 54 | * the object about the marshalling process that's going on. |
| aoqi@0 | 55 | * |
| aoqi@0 | 56 | * |
| aoqi@0 | 57 | * @return |
| aoqi@0 | 58 | * the object to be marshalled instead of <tt>this</tt> object. |
| aoqi@0 | 59 | * Or return null to indicate that the JAXB RI should behave |
| aoqi@0 | 60 | * just like when your object does not implement {@link CycleRecoverable} |
| aoqi@0 | 61 | * (IOW, cut the cycle arbitrarily and try to go on.) |
| aoqi@0 | 62 | */ |
| aoqi@0 | 63 | Object onCycleDetected(Context context); |
| aoqi@0 | 64 | |
| aoqi@0 | 65 | /** |
| aoqi@0 | 66 | * This interface is implemented by the JAXB RI to provide |
| aoqi@0 | 67 | * information about the on-going marshalling process. |
| aoqi@0 | 68 | * |
| aoqi@0 | 69 | * <p> |
| aoqi@0 | 70 | * We may add more methods in the future, so please do not |
| aoqi@0 | 71 | * implement this interface in your application. |
| aoqi@0 | 72 | */ |
| aoqi@0 | 73 | public interface Context { |
| aoqi@0 | 74 | /** |
| aoqi@0 | 75 | * Returns the marshaller object that's doing the marshalling. |
| aoqi@0 | 76 | * |
| aoqi@0 | 77 | * @return |
| aoqi@0 | 78 | * always non-null. |
| aoqi@0 | 79 | */ |
| aoqi@0 | 80 | Marshaller getMarshaller(); |
| aoqi@0 | 81 | } |
| aoqi@0 | 82 | } |
