Fri, 24 Oct 2014 15:02:28 +0200
8054367: More references for endpoints
Summary: fix also reviewed by Iaroslav.Savytskyi@oracle.com, Alexander.Fomin@oracle.com
Reviewed-by: mullan, skoivu
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.v2.runtime; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import java.io.IOException; |
aoqi@0 | 29 | |
aoqi@0 | 30 | import javax.xml.bind.annotation.XmlValue; |
aoqi@0 | 31 | import javax.xml.datatype.XMLGregorianCalendar; |
aoqi@0 | 32 | import javax.xml.namespace.QName; |
aoqi@0 | 33 | import javax.xml.stream.XMLStreamException; |
aoqi@0 | 34 | |
aoqi@0 | 35 | import com.sun.istack.internal.NotNull; |
aoqi@0 | 36 | import com.sun.xml.internal.bind.api.AccessorException; |
aoqi@0 | 37 | import com.sun.xml.internal.bind.v2.model.runtime.RuntimePropertyInfo; |
aoqi@0 | 38 | import com.sun.xml.internal.bind.v2.runtime.reflect.opt.OptimizedTransducedAccessorFactory; |
aoqi@0 | 39 | |
aoqi@0 | 40 | import org.xml.sax.SAXException; |
aoqi@0 | 41 | |
aoqi@0 | 42 | |
aoqi@0 | 43 | /** |
aoqi@0 | 44 | * Responsible for converting a Java object to a lexical representation |
aoqi@0 | 45 | * and vice versa. |
aoqi@0 | 46 | * |
aoqi@0 | 47 | * <p> |
aoqi@0 | 48 | * An implementation of this interface hides how this conversion happens. |
aoqi@0 | 49 | * |
aoqi@0 | 50 | * <p> |
aoqi@0 | 51 | * {@link Transducer}s are immutable. |
aoqi@0 | 52 | * |
aoqi@0 | 53 | * @author Kohsuke Kawaguchi (kk@kohsuke.org) |
aoqi@0 | 54 | */ |
aoqi@0 | 55 | public interface Transducer<ValueT> { |
aoqi@0 | 56 | |
aoqi@0 | 57 | /** |
aoqi@0 | 58 | * If this {@link Transducer} is the default transducer for the <code>ValueT</code>, |
aoqi@0 | 59 | * this method returns true. |
aoqi@0 | 60 | * |
aoqi@0 | 61 | * Used exclusively by {@link OptimizedTransducedAccessorFactory#get(RuntimePropertyInfo)} |
aoqi@0 | 62 | */ |
aoqi@0 | 63 | boolean isDefault(); |
aoqi@0 | 64 | |
aoqi@0 | 65 | /** |
aoqi@0 | 66 | * If true, this {@link Transducer} doesn't declare any namespace, |
aoqi@0 | 67 | * and therefore {@link #declareNamespace(Object, XMLSerializer)} is no-op. |
aoqi@0 | 68 | * |
aoqi@0 | 69 | * It also means that the {@link #parse(CharSequence)} method |
aoqi@0 | 70 | * won't use the context parameter. |
aoqi@0 | 71 | */ |
aoqi@0 | 72 | boolean useNamespace(); |
aoqi@0 | 73 | |
aoqi@0 | 74 | /** |
aoqi@0 | 75 | * Declares the namespace URIs used in the given value to {@code w}. |
aoqi@0 | 76 | * |
aoqi@0 | 77 | * @param o |
aoqi@0 | 78 | * never be null. |
aoqi@0 | 79 | * @param w |
aoqi@0 | 80 | * may be null if {@code !{@link #useNamespace()}}. |
aoqi@0 | 81 | */ |
aoqi@0 | 82 | void declareNamespace( ValueT o, XMLSerializer w ) throws AccessorException; |
aoqi@0 | 83 | |
aoqi@0 | 84 | /** |
aoqi@0 | 85 | * Converts the given value to its lexical representation. |
aoqi@0 | 86 | * |
aoqi@0 | 87 | * @param o |
aoqi@0 | 88 | * never be null. |
aoqi@0 | 89 | * @return |
aoqi@0 | 90 | * always non-null valid lexical representation. |
aoqi@0 | 91 | */ |
aoqi@0 | 92 | @NotNull CharSequence print(@NotNull ValueT o) throws AccessorException; |
aoqi@0 | 93 | |
aoqi@0 | 94 | /** |
aoqi@0 | 95 | * Converts the lexical representation to a value object. |
aoqi@0 | 96 | * |
aoqi@0 | 97 | * @param lexical |
aoqi@0 | 98 | * never be null. |
aoqi@0 | 99 | * @throws AccessorException |
aoqi@0 | 100 | * if the transducer is used to parse an user bean that uses {@link XmlValue}, |
aoqi@0 | 101 | * then this exception may occur when it tries to set the leaf value to the bean. |
aoqi@0 | 102 | * @throws SAXException |
aoqi@0 | 103 | * if the lexical form is incorrect, the error should be reported |
aoqi@0 | 104 | * and SAXException may thrown (or it can return null to recover.) |
aoqi@0 | 105 | */ |
aoqi@0 | 106 | ValueT parse(CharSequence lexical) throws AccessorException, SAXException; |
aoqi@0 | 107 | |
aoqi@0 | 108 | /** |
aoqi@0 | 109 | * Sends the result of the {@link #print(Object)} operation |
aoqi@0 | 110 | * to one of the {@link XMLSerializer#text(String, String)} method, |
aoqi@0 | 111 | * but with the best representation of the value, not necessarily String. |
aoqi@0 | 112 | */ |
aoqi@0 | 113 | void writeText(XMLSerializer w, ValueT o, String fieldName) throws IOException, SAXException, XMLStreamException, AccessorException; |
aoqi@0 | 114 | |
aoqi@0 | 115 | /** |
aoqi@0 | 116 | * Sends the result of the {@link #print(Object)} operation |
aoqi@0 | 117 | * to one of the {@link XMLSerializer#leafElement(Name, String, String)} method. |
aoqi@0 | 118 | * but with the best representation of the value, not necessarily String. |
aoqi@0 | 119 | */ |
aoqi@0 | 120 | void writeLeafElement(XMLSerializer w, Name tagName, @NotNull ValueT o, String fieldName) throws IOException, SAXException, XMLStreamException, AccessorException; |
aoqi@0 | 121 | |
aoqi@0 | 122 | /** |
aoqi@0 | 123 | * Transducers implicitly work against a single XML type, |
aoqi@0 | 124 | * but sometimes (most notably {@link XMLGregorianCalendar}, |
aoqi@0 | 125 | * an instance may choose different XML types. |
aoqi@0 | 126 | * |
aoqi@0 | 127 | * @return |
aoqi@0 | 128 | * return non-null from this method allows transducers |
aoqi@0 | 129 | * to specify the type it wants to marshal to. |
aoqi@0 | 130 | * Most of the time this method returns null, in which case |
aoqi@0 | 131 | * the implicitly associated type will be used. |
aoqi@0 | 132 | */ |
aoqi@0 | 133 | QName getTypeName(@NotNull ValueT instance); |
aoqi@0 | 134 | } |