Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/tools/internal/xjc/reader/xmlschema/bindinfo/BIDeclaration.java@0989ad8c0860 (annotated)
src/share/jaxws_classes/com/sun/tools/internal/xjc/reader/xmlschema/bindinfo/BIDeclaration.java
Tue, 09 Apr 2013 14:51:13 +0100
- author
- alanb
- date
- Tue, 09 Apr 2013 14:51:13 +0100
- changeset 368
- 0989ad8c0860
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com
| 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.tools.internal.xjc.reader.xmlschema.bindinfo; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import java.util.Collection; |
| aoqi@0 | 29 | |
| aoqi@0 | 30 | import javax.xml.namespace.QName; |
| aoqi@0 | 31 | |
| aoqi@0 | 32 | import com.sun.tools.internal.xjc.reader.xmlschema.BGMBuilder; |
| aoqi@0 | 33 | |
| aoqi@0 | 34 | import org.xml.sax.Locator; |
| aoqi@0 | 35 | |
| aoqi@0 | 36 | /** |
| aoqi@0 | 37 | * Base interface for all binding customization declarations. |
| aoqi@0 | 38 | * |
| aoqi@0 | 39 | * <p> |
| aoqi@0 | 40 | * Because of the setParent method, one customization declaration |
| aoqi@0 | 41 | * can be attached to one component alone. |
| aoqi@0 | 42 | * |
| aoqi@0 | 43 | * @author |
| aoqi@0 | 44 | * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com) |
| aoqi@0 | 45 | */ |
| aoqi@0 | 46 | public interface BIDeclaration { |
| aoqi@0 | 47 | |
| aoqi@0 | 48 | /** |
| aoqi@0 | 49 | * Sets the parent BindInfo object of this declaration. |
| aoqi@0 | 50 | * A declaration object can use this pointer to access |
| aoqi@0 | 51 | * context information, such as other customizations. |
| aoqi@0 | 52 | * |
| aoqi@0 | 53 | * <p> |
| aoqi@0 | 54 | * This method can be only called from {@link BindInfo}, |
| aoqi@0 | 55 | * and only once. This is a good opportunity to do some |
| aoqi@0 | 56 | * follow-up initialization after JAXB unmarshalling |
| aoqi@0 | 57 | * populated {@link BIDeclaration}. |
| aoqi@0 | 58 | */ |
| aoqi@0 | 59 | void setParent( BindInfo parent ); |
| aoqi@0 | 60 | |
| aoqi@0 | 61 | /** |
| aoqi@0 | 62 | * Gets the name of this binding declaration, |
| aoqi@0 | 63 | * which is the same as the tag name of the binding element. |
| aoqi@0 | 64 | */ |
| aoqi@0 | 65 | QName getName(); |
| aoqi@0 | 66 | |
| aoqi@0 | 67 | /** |
| aoqi@0 | 68 | * Gets the source location where this declaration was written. |
| aoqi@0 | 69 | * For declarations that are generated by XJC itself, |
| aoqi@0 | 70 | * this method returns null. |
| aoqi@0 | 71 | */ |
| aoqi@0 | 72 | Locator getLocation(); |
| aoqi@0 | 73 | |
| aoqi@0 | 74 | /** |
| aoqi@0 | 75 | * Marks this declaration to be acknowledged -- either actually |
| aoqi@0 | 76 | * used or the existence is admitted (for example when |
| aoqi@0 | 77 | * a property customization is given at the point of definition.) |
| aoqi@0 | 78 | * |
| aoqi@0 | 79 | * <p> |
| aoqi@0 | 80 | * Declarations that are not acknowledged will be considered |
| aoqi@0 | 81 | * as an error. |
| aoqi@0 | 82 | */ |
| aoqi@0 | 83 | void markAsAcknowledged(); |
| aoqi@0 | 84 | |
| aoqi@0 | 85 | /** |
| aoqi@0 | 86 | * Checks if this declaration was acknowledged. |
| aoqi@0 | 87 | */ |
| aoqi@0 | 88 | boolean isAcknowledged(); |
| aoqi@0 | 89 | |
| aoqi@0 | 90 | /** |
| aoqi@0 | 91 | * Called when the parent {@link BindInfo} got its owner set. |
| aoqi@0 | 92 | * |
| aoqi@0 | 93 | * This is when declarations are connected to {@link BGMBuilder} and |
| aoqi@0 | 94 | * its sibling components. |
| aoqi@0 | 95 | */ |
| aoqi@0 | 96 | void onSetOwner(); |
| aoqi@0 | 97 | |
| aoqi@0 | 98 | /** |
| aoqi@0 | 99 | * Gets child {@link BIDeclaration}s if any. |
| aoqi@0 | 100 | * |
| aoqi@0 | 101 | * @return |
| aoqi@0 | 102 | * can be empty but always non-null. read-only. |
| aoqi@0 | 103 | */ |
| aoqi@0 | 104 | Collection<BIDeclaration> getChildren(); |
| aoqi@0 | 105 | } |
