src/share/jaxws_classes/com/sun/xml/internal/bind/v2/model/core/TypeInfoSet.java

Thu, 31 Aug 2017 15:18:52 +0800

author
aoqi
date
Thu, 31 Aug 2017 15:18:52 +0800
changeset 637
9c07ef4934dd
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.v2.model.core;
aoqi@0 27
aoqi@0 28 import java.util.Map;
aoqi@0 29
aoqi@0 30 import javax.xml.bind.JAXBException;
aoqi@0 31 import javax.xml.bind.annotation.XmlSchema;
aoqi@0 32 import javax.xml.bind.annotation.XmlNsForm;
aoqi@0 33 import javax.xml.namespace.QName;
aoqi@0 34 import javax.xml.transform.Result;
aoqi@0 35
aoqi@0 36 import com.sun.xml.internal.bind.v2.model.nav.Navigator;
aoqi@0 37
aoqi@0 38 /**
aoqi@0 39 * Root of models. Set of {@link TypeInfo}s.
aoqi@0 40 *
aoqi@0 41 * @author Kohsuke Kawaguchi
aoqi@0 42 */
aoqi@0 43 public interface TypeInfoSet<T,C,F,M> {
aoqi@0 44
aoqi@0 45 /**
aoqi@0 46 * {@link Navigator} for this model.
aoqi@0 47 */
aoqi@0 48 Navigator<T,C,F,M> getNavigator();
aoqi@0 49
aoqi@0 50 // turns out we can't have AnnotationReader in XJC, so it's impossible to have this here.
aoqi@0 51 // perhaps we should revisit this in the future.
aoqi@0 52 // /**
aoqi@0 53 // * {@link AnnotationReader} for this model.
aoqi@0 54 // */
aoqi@0 55 // AnnotationReader<T,C,F,M> getReader();
aoqi@0 56
aoqi@0 57 /**
aoqi@0 58 * Returns a {@link TypeInfo} for the given type.
aoqi@0 59 *
aoqi@0 60 * @return
aoqi@0 61 * null if the specified type cannot be bound by JAXB, or
aoqi@0 62 * not known to this set.
aoqi@0 63 */
aoqi@0 64 NonElement<T,C> getTypeInfo( T type );
aoqi@0 65
aoqi@0 66 /**
aoqi@0 67 * Gets the {@link TypeInfo} for the any type.
aoqi@0 68 */
aoqi@0 69 NonElement<T,C> getAnyTypeInfo();
aoqi@0 70
aoqi@0 71 /**
aoqi@0 72 * Returns a {@link ClassInfo}, {@link ArrayInfo}, or {@link LeafInfo}
aoqi@0 73 * for the given bean.
aoqi@0 74 *
aoqi@0 75 * <p>
aoqi@0 76 * This method is almost like refinement of {@link #getTypeInfo(Object)} except
aoqi@0 77 * our C cannot derive from T.
aoqi@0 78 *
aoqi@0 79 * @return
aoqi@0 80 * null if the specified type is not bound by JAXB or otherwise
aoqi@0 81 * unknown to this set.
aoqi@0 82 */
aoqi@0 83 NonElement<T,C> getClassInfo( C type );
aoqi@0 84
aoqi@0 85 /**
aoqi@0 86 * Returns all the {@link ArrayInfo}s known to this set.
aoqi@0 87 */
aoqi@0 88 Map<? extends T,? extends ArrayInfo<T,C>> arrays();
aoqi@0 89
aoqi@0 90 /**
aoqi@0 91 * Returns all the {@link ClassInfo}s known to this set.
aoqi@0 92 */
aoqi@0 93 Map<C,? extends ClassInfo<T,C>> beans();
aoqi@0 94
aoqi@0 95 /**
aoqi@0 96 * Returns all the {@link BuiltinLeafInfo}s known to this set.
aoqi@0 97 */
aoqi@0 98 Map<T,? extends BuiltinLeafInfo<T,C>> builtins();
aoqi@0 99
aoqi@0 100 /**
aoqi@0 101 * Returns all the {@link EnumLeafInfo}s known to this set.
aoqi@0 102 */
aoqi@0 103 Map<C,? extends EnumLeafInfo<T,C>> enums();
aoqi@0 104
aoqi@0 105 /**
aoqi@0 106 * Returns a {@link ElementInfo} for the given element.
aoqi@0 107 *
aoqi@0 108 * @param scope
aoqi@0 109 * if null, return the info about a global element.
aoqi@0 110 * Otherwise return a local element in the given scope if available,
aoqi@0 111 * then look for a global element next.
aoqi@0 112 */
aoqi@0 113 ElementInfo<T,C> getElementInfo( C scope, QName name );
aoqi@0 114
aoqi@0 115 /**
aoqi@0 116 * Returns a type information for the given reference.
aoqi@0 117 */
aoqi@0 118 NonElement<T,C> getTypeInfo(Ref<T,C> ref);
aoqi@0 119
aoqi@0 120 /**
aoqi@0 121 * Returns all {@link ElementInfo}s in the given scope.
aoqi@0 122 *
aoqi@0 123 * @param scope
aoqi@0 124 * if non-null, this method only returns the local element mapping.
aoqi@0 125 */
aoqi@0 126 Map<QName,? extends ElementInfo<T,C>> getElementMappings( C scope );
aoqi@0 127
aoqi@0 128 /**
aoqi@0 129 * Returns all the {@link ElementInfo} known to this set.
aoqi@0 130 */
aoqi@0 131 Iterable<? extends ElementInfo<T,C>> getAllElements();
aoqi@0 132
aoqi@0 133
aoqi@0 134 /**
aoqi@0 135 * Gets all {@link XmlSchema#xmlns()} found in this context for the given namespace URI.
aoqi@0 136 *
aoqi@0 137 * <p>
aoqi@0 138 * This operation is expected to be only used in schema generator, so it can be slow.
aoqi@0 139 *
aoqi@0 140 * @return
aoqi@0 141 * A map from prefixes to namespace URIs, which should be declared when generating a schema.
aoqi@0 142 * Could be empty but never null.
aoqi@0 143 */
aoqi@0 144 Map<String,String> getXmlNs(String namespaceUri);
aoqi@0 145
aoqi@0 146 /**
aoqi@0 147 * Gets {@link XmlSchema#location()} found in this context.
aoqi@0 148 *
aoqi@0 149 * <p>
aoqi@0 150 * This operation is expected to be only used in schema generator, so it can be slow.
aoqi@0 151 *
aoqi@0 152 * @return
aoqi@0 153 * A map from namespace URI to the value of the location.
aoqi@0 154 * If the entry is missing, that means a schema should be generated for that namespace.
aoqi@0 155 * If the value is "", that means the schema location is implied
aoqi@0 156 * (&lt;xs:schema namespace="..."/> w/o schemaLocation.)
aoqi@0 157 */
aoqi@0 158 Map<String,String> getSchemaLocations();
aoqi@0 159
aoqi@0 160 /**
aoqi@0 161 * Gets the reasonable {@link XmlNsForm} for the given namespace URI.
aoqi@0 162 *
aoqi@0 163 * <p>
aoqi@0 164 * The spec doesn't define very precisely what the {@link XmlNsForm} value
aoqi@0 165 * for the given namespace would be, so this method is implemented in rather
aoqi@0 166 * ad-hoc way. It should work as what most people expect for simple cases.
aoqi@0 167 *
aoqi@0 168 * @return never null.
aoqi@0 169 */
aoqi@0 170 XmlNsForm getElementFormDefault(String nsUri);
aoqi@0 171
aoqi@0 172 /**
aoqi@0 173 * Gets the reasonable {@link XmlNsForm} for the given namespace URI.
aoqi@0 174 *
aoqi@0 175 * <p>
aoqi@0 176 * The spec doesn't define very precisely what the {@link XmlNsForm} value
aoqi@0 177 * for the given namespace would be, so this method is implemented in rather
aoqi@0 178 * ad-hoc way. It should work as what most people expect for simple cases.
aoqi@0 179 *
aoqi@0 180 * @return never null.
aoqi@0 181 */
aoqi@0 182 XmlNsForm getAttributeFormDefault(String nsUri);
aoqi@0 183
aoqi@0 184 /**
aoqi@0 185 * Dumps this model into XML.
aoqi@0 186 *
aoqi@0 187 * For debug only.
aoqi@0 188 *
aoqi@0 189 * TODO: not sure if this actually works. We don't really know what are T,C.
aoqi@0 190 */
aoqi@0 191 public void dump( Result out ) throws JAXBException;
aoqi@0 192 }

mercurial