Fri, 04 Oct 2013 16:21:34 +0100
8025054: Update JAX-WS RI integration to 2.2.9-b130926.1035
Reviewed-by: chegar
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 1997, 2010, 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.xsom; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import com.sun.xml.internal.xsom.parser.SchemaDocument; |
aoqi@0 | 29 | import com.sun.xml.internal.xsom.visitor.XSFunction; |
aoqi@0 | 30 | import com.sun.xml.internal.xsom.visitor.XSVisitor; |
aoqi@0 | 31 | import org.xml.sax.Locator; |
aoqi@0 | 32 | |
aoqi@0 | 33 | import javax.xml.namespace.NamespaceContext; |
aoqi@0 | 34 | import java.util.List; |
aoqi@0 | 35 | import java.util.Collection; |
aoqi@0 | 36 | |
aoqi@0 | 37 | /** |
aoqi@0 | 38 | * Base interface for all the schema components. |
aoqi@0 | 39 | * |
aoqi@0 | 40 | * @author |
aoqi@0 | 41 | * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com) |
aoqi@0 | 42 | */ |
aoqi@0 | 43 | public interface XSComponent |
aoqi@0 | 44 | { |
aoqi@0 | 45 | /** Gets the annotation associated to this component, if any. */ |
aoqi@0 | 46 | XSAnnotation getAnnotation(); |
aoqi@0 | 47 | |
aoqi@0 | 48 | /** |
aoqi@0 | 49 | * Works like {@link #getAnnotation()}, but allow a new empty {@link XSAnnotation} to be created |
aoqi@0 | 50 | * if not exist. |
aoqi@0 | 51 | * |
aoqi@0 | 52 | * @param createIfNotExist |
aoqi@0 | 53 | * true to create a new {@link XSAnnotation} if it doesn't exist already. |
aoqi@0 | 54 | * false to make this method behavel like {@link #getAnnotation()}. |
aoqi@0 | 55 | * |
aoqi@0 | 56 | * @return |
aoqi@0 | 57 | * null if <tt>createIfNotExist==false</tt> and annotation didn't exist. |
aoqi@0 | 58 | * Otherwise non-null. |
aoqi@0 | 59 | */ |
aoqi@0 | 60 | XSAnnotation getAnnotation(boolean createIfNotExist); |
aoqi@0 | 61 | |
aoqi@0 | 62 | /** |
aoqi@0 | 63 | * Gets the foreign attributes on this schema component. |
aoqi@0 | 64 | * |
aoqi@0 | 65 | * <p> |
aoqi@0 | 66 | * In general, a schema component may match multiple elements |
aoqi@0 | 67 | * in a schema document, and those elements can individually |
aoqi@0 | 68 | * carry foreign attributes. |
aoqi@0 | 69 | * |
aoqi@0 | 70 | * <p> |
aoqi@0 | 71 | * This method returns a list of {@link ForeignAttributes}, where |
aoqi@0 | 72 | * each {@link ForeignAttributes} object represent foreign attributes |
aoqi@0 | 73 | * on one element. |
aoqi@0 | 74 | * |
aoqi@0 | 75 | * @return |
aoqi@0 | 76 | * can be an empty list but never be null. |
aoqi@0 | 77 | */ |
aoqi@0 | 78 | List<? extends ForeignAttributes> getForeignAttributes(); |
aoqi@0 | 79 | |
aoqi@0 | 80 | /** |
aoqi@0 | 81 | * Gets the foreign attribute of the given name, or null if not found. |
aoqi@0 | 82 | * |
aoqi@0 | 83 | * <p> |
aoqi@0 | 84 | * If multiple occurences of the same attribute is found, |
aoqi@0 | 85 | * this method returns the first one. |
aoqi@0 | 86 | * |
aoqi@0 | 87 | * @see #getForeignAttributes() |
aoqi@0 | 88 | */ |
aoqi@0 | 89 | String getForeignAttribute(String nsUri, String localName); |
aoqi@0 | 90 | |
aoqi@0 | 91 | /** |
aoqi@0 | 92 | * Gets the locator that indicates the source location where |
aoqi@0 | 93 | * this component is created from, or null if no information is |
aoqi@0 | 94 | * available. |
aoqi@0 | 95 | */ |
aoqi@0 | 96 | Locator getLocator(); |
aoqi@0 | 97 | |
aoqi@0 | 98 | /** |
aoqi@0 | 99 | * Gets a reference to the {@link XSSchema} object to which this component |
aoqi@0 | 100 | * belongs. |
aoqi@0 | 101 | * <p> |
aoqi@0 | 102 | * In case of <code>XSEmpty</code> component, this method |
aoqi@0 | 103 | * returns null since there is no owner component. |
aoqi@0 | 104 | */ |
aoqi@0 | 105 | XSSchema getOwnerSchema(); |
aoqi@0 | 106 | |
aoqi@0 | 107 | /** |
aoqi@0 | 108 | * Gets the root schema set that includes this component. |
aoqi@0 | 109 | * |
aoqi@0 | 110 | * <p> |
aoqi@0 | 111 | * In case of <code>XSEmpty</code> component, this method |
aoqi@0 | 112 | * returns null since there is no owner component. |
aoqi@0 | 113 | */ |
aoqi@0 | 114 | XSSchemaSet getRoot(); |
aoqi@0 | 115 | |
aoqi@0 | 116 | /** |
aoqi@0 | 117 | * Gets the {@link SchemaDocument} that indicates which document this component |
aoqi@0 | 118 | * was defined in. |
aoqi@0 | 119 | * |
aoqi@0 | 120 | * @return |
aoqi@0 | 121 | * null for components that are built-in to XML Schema, such |
aoqi@0 | 122 | * as anyType, or "empty" {@link XSContentType}. This method also |
aoqi@0 | 123 | * returns null for {@link XSSchema}. |
aoqi@0 | 124 | * For all other user-defined |
aoqi@0 | 125 | * components this method returns non-null, even if they are local. |
aoqi@0 | 126 | */ |
aoqi@0 | 127 | SchemaDocument getSourceDocument(); |
aoqi@0 | 128 | |
aoqi@0 | 129 | /** |
aoqi@0 | 130 | * Evaluates a schema component designator against this schema component |
aoqi@0 | 131 | * and returns the resulting schema components. |
aoqi@0 | 132 | * |
aoqi@0 | 133 | * @throws IllegalArgumentException |
aoqi@0 | 134 | * if SCD is syntactically incorrect. |
aoqi@0 | 135 | * |
aoqi@0 | 136 | * @param scd |
aoqi@0 | 137 | * Schema component designator. See {@link SCD} for more details. |
aoqi@0 | 138 | * @param nsContext |
aoqi@0 | 139 | * The namespace context in which SCD is evaluated. Cannot be null. |
aoqi@0 | 140 | * @return |
aoqi@0 | 141 | * Can be empty but never null. |
aoqi@0 | 142 | */ |
aoqi@0 | 143 | Collection<XSComponent> select(String scd, NamespaceContext nsContext); |
aoqi@0 | 144 | |
aoqi@0 | 145 | /** |
aoqi@0 | 146 | * Evaluates a schema component designator against this schema component |
aoqi@0 | 147 | * and returns the first resulting schema component. |
aoqi@0 | 148 | * |
aoqi@0 | 149 | * @throws IllegalArgumentException |
aoqi@0 | 150 | * if SCD is syntactically incorrect. |
aoqi@0 | 151 | * |
aoqi@0 | 152 | * @param scd |
aoqi@0 | 153 | * Schema component designator. See {@link SCD} for more details. |
aoqi@0 | 154 | * @param nsContext |
aoqi@0 | 155 | * The namespace context in which SCD is evaluated. Cannot be null. |
aoqi@0 | 156 | * @return |
aoqi@0 | 157 | * null if the SCD didn't match anything. If the SCD matched more than one node, |
aoqi@0 | 158 | * the first one will be returned. |
aoqi@0 | 159 | */ |
aoqi@0 | 160 | XSComponent selectSingle(String scd, NamespaceContext nsContext); |
aoqi@0 | 161 | |
aoqi@0 | 162 | /** |
aoqi@0 | 163 | * Accepts a visitor. |
aoqi@0 | 164 | */ |
aoqi@0 | 165 | void visit( XSVisitor visitor ); |
aoqi@0 | 166 | /** |
aoqi@0 | 167 | * Accepts a functor. |
aoqi@0 | 168 | */ |
aoqi@0 | 169 | <T> T apply( XSFunction<T> function ); |
aoqi@0 | 170 | } |