spinjar.com.sun.xml.bind.CycleRecoverable Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.bind;
import javax.xml.bind.Marshaller;
/**
* Optional interface that can be implemented by JAXB-bound objects
* to handle cycles in the object graph.
*
*
* As discussed in
* the users' guide, normally a cycle in the object graph causes the marshaller to report an error,
* and when an error is found, the JAXB RI recovers by cutting the cycle arbitrarily.
* This is not always a desired behavior.
*
*
* Implementing this interface allows user application to change this behavior.
* Also see this related discussion.
*
* @since JAXB 2.1 EA2
* @author Kohsuke Kawaguchi
*/
public interface CycleRecoverable {
/**
* Called when a cycle is detected by the JAXB RI marshaller
* to nominate a new object to be marshalled instead.
*
* @param context
* This object is provided by the JAXB RI to inform
* the object about the marshalling process that's going on.
*
*
* @return
* the object to be marshalled instead of this object.
* Or return null to indicate that the JAXB RI should behave
* just like when your object does not implement {@link CycleRecoverable}
* (IOW, cut the cycle arbitrarily and try to go on.)
*/
Object onCycleDetected(Context context);
/**
* This interface is implemented by the JAXB RI to provide
* information about the on-going marshalling process.
*
*
* We may add more methods in the future, so please do not
* implement this interface in your application.
*/
public interface Context {
/**
* Returns the marshaller object that's doing the marshalling.
*
* @return
* always non-null.
*/
Marshaller getMarshaller();
}
}