Tue, 06 Mar 2012 16:09:35 -0800
7150322: Stop using drop source bundles in jaxws
Reviewed-by: darcy, ohrstrom
ohair@286 | 1 | /* |
ohair@286 | 2 | * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. |
ohair@286 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
ohair@286 | 4 | * |
ohair@286 | 5 | * This code is free software; you can redistribute it and/or modify it |
ohair@286 | 6 | * under the terms of the GNU General Public License version 2 only, as |
ohair@286 | 7 | * published by the Free Software Foundation. Oracle designates this |
ohair@286 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@286 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
ohair@286 | 10 | * |
ohair@286 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
ohair@286 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
ohair@286 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
ohair@286 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
ohair@286 | 15 | * accompanied this code). |
ohair@286 | 16 | * |
ohair@286 | 17 | * You should have received a copy of the GNU General Public License version |
ohair@286 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
ohair@286 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
ohair@286 | 20 | * |
ohair@286 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@286 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@286 | 23 | * questions. |
ohair@286 | 24 | */ |
ohair@286 | 25 | |
ohair@286 | 26 | package javax.xml.bind.annotation; |
ohair@286 | 27 | |
ohair@286 | 28 | import javax.xml.bind.ValidationEventHandler; |
ohair@286 | 29 | import javax.xml.transform.Result; |
ohair@286 | 30 | import javax.xml.transform.Source; |
ohair@286 | 31 | |
ohair@286 | 32 | /** |
ohair@286 | 33 | * Converts an element (and its descendants) |
ohair@286 | 34 | * from/to DOM (or similar) representation. |
ohair@286 | 35 | * |
ohair@286 | 36 | * <p> |
ohair@286 | 37 | * Implementations of this interface will be used in conjunction with |
ohair@286 | 38 | * {@link XmlAnyElement} annotation to map an element of XML into a representation |
ohair@286 | 39 | * of infoset such as W3C DOM. |
ohair@286 | 40 | * |
ohair@286 | 41 | * <p> |
ohair@286 | 42 | * Implementations hide how a portion of XML is converted into/from such |
ohair@286 | 43 | * DOM-like representation, allowing JAXB providers to work with arbitrary |
ohair@286 | 44 | * such library. |
ohair@286 | 45 | * |
ohair@286 | 46 | * <P> |
ohair@286 | 47 | * This interface is intended to be implemented by library writers |
ohair@286 | 48 | * and consumed by JAXB providers. None of those methods are intended to |
ohair@286 | 49 | * be called from applications. |
ohair@286 | 50 | * |
ohair@286 | 51 | * @author Kohsuke Kawaguchi |
ohair@286 | 52 | * @since JAXB2.0 |
ohair@286 | 53 | */ |
ohair@286 | 54 | public interface DomHandler<ElementT,ResultT extends Result> { |
ohair@286 | 55 | /** |
ohair@286 | 56 | * When a JAXB provider needs to unmarshal a part of a document into an |
ohair@286 | 57 | * infoset representation, it first calls this method to create a |
ohair@286 | 58 | * {@link Result} object. |
ohair@286 | 59 | * |
ohair@286 | 60 | * <p> |
ohair@286 | 61 | * A JAXB provider will then send a portion of the XML |
ohair@286 | 62 | * into the given result. Such a portion always form a subtree |
ohair@286 | 63 | * of the whole XML document rooted at an element. |
ohair@286 | 64 | * |
ohair@286 | 65 | * @param errorHandler |
ohair@286 | 66 | * if any error happens between the invocation of this method |
ohair@286 | 67 | * and the invocation of {@link #getElement(Result)}, they |
ohair@286 | 68 | * must be reported to this handler. |
ohair@286 | 69 | * |
ohair@286 | 70 | * The caller must provide a non-null error handler. |
ohair@286 | 71 | * |
ohair@286 | 72 | * The {@link Result} object created from this method |
ohair@286 | 73 | * may hold a reference to this error handler. |
ohair@286 | 74 | * |
ohair@286 | 75 | * @return |
ohair@286 | 76 | * null if the operation fails. The error must have been reported |
ohair@286 | 77 | * to the error handler. |
ohair@286 | 78 | */ |
ohair@286 | 79 | ResultT createUnmarshaller( ValidationEventHandler errorHandler ); |
ohair@286 | 80 | |
ohair@286 | 81 | /** |
ohair@286 | 82 | * Once the portion is sent to the {@link Result}. This method is called |
ohair@286 | 83 | * by a JAXB provider to obtain the unmarshalled element representation. |
ohair@286 | 84 | * |
ohair@286 | 85 | * <p> |
ohair@286 | 86 | * Multiple invocations of this method may return different objects. |
ohair@286 | 87 | * This method can be invoked only when the whole sub-tree are fed |
ohair@286 | 88 | * to the {@link Result} object. |
ohair@286 | 89 | * |
ohair@286 | 90 | * @param rt |
ohair@286 | 91 | * The {@link Result} object created by {@link #createUnmarshaller(ValidationEventHandler)}. |
ohair@286 | 92 | * |
ohair@286 | 93 | * @return |
ohair@286 | 94 | * null if the operation fails. The error must have been reported |
ohair@286 | 95 | * to the error handler. |
ohair@286 | 96 | */ |
ohair@286 | 97 | ElementT getElement(ResultT rt); |
ohair@286 | 98 | |
ohair@286 | 99 | /** |
ohair@286 | 100 | * This method is called when a JAXB provider needs to marshal an element |
ohair@286 | 101 | * to XML. |
ohair@286 | 102 | * |
ohair@286 | 103 | * <p> |
ohair@286 | 104 | * If non-null, the returned {@link Source} must contain a whole document |
ohair@286 | 105 | * rooted at one element, which will then be weaved into a bigger document |
ohair@286 | 106 | * that the JAXB provider is marshalling. |
ohair@286 | 107 | * |
ohair@286 | 108 | * @param errorHandler |
ohair@286 | 109 | * Receives any errors happened during the process of converting |
ohair@286 | 110 | * an element into a {@link Source}. |
ohair@286 | 111 | * |
ohair@286 | 112 | * The caller must provide a non-null error handler. |
ohair@286 | 113 | * |
ohair@286 | 114 | * @return |
ohair@286 | 115 | * null if there was an error. The error should have been reported |
ohair@286 | 116 | * to the handler. |
ohair@286 | 117 | */ |
ohair@286 | 118 | Source marshal( ElementT n, ValidationEventHandler errorHandler ); |
ohair@286 | 119 | } |