001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036: package com.sun.tools.xjc.reader.xmlschema.bindinfo;
037:
038: import java.util.Collection;
039:
040: import javax.xml.namespace.QName;
041:
042: import com.sun.tools.xjc.reader.xmlschema.BGMBuilder;
043:
044: import org.xml.sax.Locator;
045:
046: /**
047: * Base interface for all binding customization declarations.
048: *
049: * <p>
050: * Because of the setParent method, one customization declaration
051: * can be attached to one component alone.
052: *
053: * @author
054: * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
055: */
056: public interface BIDeclaration {
057:
058: /**
059: * Sets the parent BindInfo object of this declaration.
060: * A declaration object can use this pointer to access
061: * context information, such as other customizations.
062: *
063: * <p>
064: * This method can be only called from {@link BindInfo},
065: * and only once. This is a good opportunity to do some
066: * follow-up initialization after JAXB unmarshalling
067: * populated {@link BIDeclaration}.
068: */
069: void setParent(BindInfo parent);
070:
071: /**
072: * Gets the name of this binding declaration,
073: * which is the same as the tag name of the binding element.
074: */
075: QName getName();
076:
077: /**
078: * Gets the source location where this declaration was written.
079: * For declarations that are generated by XJC itself,
080: * this method returns null.
081: */
082: Locator getLocation();
083:
084: /**
085: * Marks this declaration to be acknowledged -- either actually
086: * used or the existence is admitted (for example when
087: * a property customization is given at the point of definition.)
088: *
089: * <p>
090: * Declarations that are not acknowledged will be considered
091: * as an error.
092: */
093: void markAsAcknowledged();
094:
095: /**
096: * Checks if this declaration was acknowledged.
097: */
098: boolean isAcknowledged();
099:
100: /**
101: * Called when the parent {@link BindInfo} got its owner set.
102: *
103: * This is when declarations are connected to {@link BGMBuilder} and
104: * its sibling components.
105: */
106: void onSetOwner();
107:
108: /**
109: * Gets child {@link BIDeclaration}s if any.
110: *
111: * @return
112: * can be empty but always non-null. read-only.
113: */
114: Collection<BIDeclaration> getChildren();
115: }
|