Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/xsom/XSElementDecl.java@e530533619ec (annotated)
src/share/jaxws_classes/com/sun/xml/internal/xsom/XSElementDecl.java
Thu, 12 Oct 2017 19:44:07 +0800
- author
- aoqi
- date
- Thu, 12 Oct 2017 19:44:07 +0800
- changeset 760
- e530533619ec
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
merge
| 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 java.util.List; |
| aoqi@0 | 29 | import java.util.Set; |
| aoqi@0 | 30 | |
| aoqi@0 | 31 | /** |
| aoqi@0 | 32 | * Element declaration. |
| aoqi@0 | 33 | * |
| aoqi@0 | 34 | * @author |
| aoqi@0 | 35 | * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com) |
| aoqi@0 | 36 | */ |
| aoqi@0 | 37 | public interface XSElementDecl extends XSDeclaration, XSTerm |
| aoqi@0 | 38 | { |
| aoqi@0 | 39 | /** |
| aoqi@0 | 40 | * Gets the type of this element declaration. |
| aoqi@0 | 41 | * @return |
| aoqi@0 | 42 | * always non-null. |
| aoqi@0 | 43 | */ |
| aoqi@0 | 44 | XSType getType(); |
| aoqi@0 | 45 | |
| aoqi@0 | 46 | boolean isNillable(); |
| aoqi@0 | 47 | |
| aoqi@0 | 48 | /** |
| aoqi@0 | 49 | * Gets the substitution head of this element, if any. |
| aoqi@0 | 50 | * Otherwise null. |
| aoqi@0 | 51 | */ |
| aoqi@0 | 52 | XSElementDecl getSubstAffiliation(); |
| aoqi@0 | 53 | |
| aoqi@0 | 54 | /** |
| aoqi@0 | 55 | * Returns all the {@link XSIdentityConstraint}s in this element decl. |
| aoqi@0 | 56 | * |
| aoqi@0 | 57 | * @return |
| aoqi@0 | 58 | * never null, but can be empty. |
| aoqi@0 | 59 | */ |
| aoqi@0 | 60 | List<XSIdentityConstraint> getIdentityConstraints(); |
| aoqi@0 | 61 | |
| aoqi@0 | 62 | /** |
| aoqi@0 | 63 | * Checks the substitution excluded property of the schema component. |
| aoqi@0 | 64 | * |
| aoqi@0 | 65 | * IOW, this checks the value of the <code>final</code> attribute |
| aoqi@0 | 66 | * (plus <code>finalDefault</code>). |
| aoqi@0 | 67 | * |
| aoqi@0 | 68 | * @param method |
| aoqi@0 | 69 | * Possible values are {@link XSType#EXTENSION} or |
| aoqi@0 | 70 | * <code>XSType.RESTRICTION</code>. |
| aoqi@0 | 71 | */ |
| aoqi@0 | 72 | boolean isSubstitutionExcluded(int method); |
| aoqi@0 | 73 | |
| aoqi@0 | 74 | /** |
| aoqi@0 | 75 | * Checks the diallowed substitution property of the schema component. |
| aoqi@0 | 76 | * |
| aoqi@0 | 77 | * IOW, this checks the value of the <code>block</code> attribute |
| aoqi@0 | 78 | * (plus <code>blockDefault</code>). |
| aoqi@0 | 79 | * |
| aoqi@0 | 80 | * @param method |
| aoqi@0 | 81 | * Possible values are {@link XSType#EXTENSION}, |
| aoqi@0 | 82 | * <code>XSType.RESTRICTION</code>, or <code>XSType.SUBSTITUTION</code> |
| aoqi@0 | 83 | */ |
| aoqi@0 | 84 | boolean isSubstitutionDisallowed(int method); |
| aoqi@0 | 85 | |
| aoqi@0 | 86 | boolean isAbstract(); |
| aoqi@0 | 87 | |
| aoqi@0 | 88 | /** |
| aoqi@0 | 89 | * Returns the element declarations that can substitute |
| aoqi@0 | 90 | * this element. |
| aoqi@0 | 91 | * |
| aoqi@0 | 92 | * <p> |
| aoqi@0 | 93 | * IOW, this set returns all the element decls that satisfies |
| aoqi@0 | 94 | * <a href="http://www.w3.org/TR/xmlschema-1/#cos-equiv-derived-ok-rec"> |
| aoqi@0 | 95 | * the "Substitution Group OK" constraint. |
| aoqi@0 | 96 | * </a> |
| aoqi@0 | 97 | * |
| aoqi@0 | 98 | * @return |
| aoqi@0 | 99 | * nun-null valid array. The return value always contains this element |
| aoqi@0 | 100 | * decl itself. |
| aoqi@0 | 101 | * |
| aoqi@0 | 102 | * @deprecated |
| aoqi@0 | 103 | * this method allocates a new array every time, so it could be |
| aoqi@0 | 104 | * inefficient when working with a large schema. Use |
| aoqi@0 | 105 | * {@link #getSubstitutables()} instead. |
| aoqi@0 | 106 | */ |
| aoqi@0 | 107 | XSElementDecl[] listSubstitutables(); |
| aoqi@0 | 108 | |
| aoqi@0 | 109 | /** |
| aoqi@0 | 110 | * Returns the element declarations that can substitute |
| aoqi@0 | 111 | * this element. |
| aoqi@0 | 112 | * |
| aoqi@0 | 113 | * <p> |
| aoqi@0 | 114 | * IOW, this set returns all the element decls that satisfies |
| aoqi@0 | 115 | * <a href="http://www.w3.org/TR/xmlschema-1/#cos-equiv-derived-ok-rec"> |
| aoqi@0 | 116 | * the "Substitution Group OK" constraint. |
| aoqi@0 | 117 | * </a> |
| aoqi@0 | 118 | * |
| aoqi@0 | 119 | * <p> |
| aoqi@0 | 120 | * Note that the above clause does <em>NOT</em> check for |
| aoqi@0 | 121 | * abstract elements. So abstract elements may still show up |
| aoqi@0 | 122 | * in the returned set. |
| aoqi@0 | 123 | * |
| aoqi@0 | 124 | * @return |
| aoqi@0 | 125 | * nun-null unmodifiable list. |
| aoqi@0 | 126 | * The returned list always contains this element decl itself. |
| aoqi@0 | 127 | */ |
| aoqi@0 | 128 | Set<? extends XSElementDecl> getSubstitutables(); |
| aoqi@0 | 129 | |
| aoqi@0 | 130 | /** |
| aoqi@0 | 131 | * Returns true if this element declaration can be validly substituted |
| aoqi@0 | 132 | * by the given declaration. |
| aoqi@0 | 133 | * |
| aoqi@0 | 134 | * <p> |
| aoqi@0 | 135 | * Just a short cut of <tt>getSubstitutables().contain(e);</tt> |
| aoqi@0 | 136 | */ |
| aoqi@0 | 137 | boolean canBeSubstitutedBy(XSElementDecl e); |
| aoqi@0 | 138 | |
| aoqi@0 | 139 | // TODO: identitiy constraints |
| aoqi@0 | 140 | // TODO: scope |
| aoqi@0 | 141 | |
| aoqi@0 | 142 | XmlString getDefaultValue(); |
| aoqi@0 | 143 | XmlString getFixedValue(); |
| aoqi@0 | 144 | |
| aoqi@0 | 145 | /** |
| aoqi@0 | 146 | * Used for javadoc schema generation |
| aoqi@0 | 147 | * |
| aoqi@0 | 148 | * @return |
| aoqi@0 | 149 | * null if form attribute not present, |
| aoqi@0 | 150 | * true if form attribute present and set to qualified, |
| aoqi@0 | 151 | * false if form attribute present and set to unqualified. |
| aoqi@0 | 152 | */ |
| aoqi@0 | 153 | |
| aoqi@0 | 154 | Boolean getForm(); |
| aoqi@0 | 155 | } |
