001: /*
002: * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
003: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004: *
005: * This code is free software; you can redistribute it and/or modify it
006: * under the terms of the GNU General Public License version 2 only, as
007: * published by the Free Software Foundation. Sun designates this
008: * particular file as subject to the "Classpath" exception as provided
009: * by Sun in the LICENSE file that accompanied this code.
010: *
011: * This code is distributed in the hope that it will be useful, but WITHOUT
012: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014: * version 2 for more details (a copy is included in the LICENSE file that
015: * accompanied this code).
016: *
017: * You should have received a copy of the GNU General Public License version
018: * 2 along with this work; if not, write to the Free Software Foundation,
019: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020: *
021: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022: * CA 95054 USA or visit www.sun.com if you need additional information or
023: * have any questions.
024: */
025:
026: package com.sun.tools.internal.xjc.reader.xmlschema.bindinfo;
027:
028: import java.util.Collection;
029:
030: import javax.xml.namespace.QName;
031:
032: import com.sun.tools.internal.xjc.reader.xmlschema.BGMBuilder;
033:
034: import org.xml.sax.Locator;
035:
036: /**
037: * Base interface for all binding customization declarations.
038: *
039: * <p>
040: * Because of the setParent method, one customization declaration
041: * can be attached to one component alone.
042: *
043: * @author
044: * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
045: */
046: public interface BIDeclaration {
047:
048: /**
049: * Sets the parent BindInfo object of this declaration.
050: * A declaration object can use this pointer to access
051: * context information, such as other customizations.
052: *
053: * <p>
054: * This method can be only called from {@link BindInfo},
055: * and only once.
056: */
057: void setParent(BindInfo parent);
058:
059: /**
060: * Gets the name of this binding declaration,
061: * which is the same as the tag name of the binding element.
062: */
063: QName getName();
064:
065: /**
066: * Gets the source location where this declaration was written.
067: * For declarations that are generated by XJC itself,
068: * this method returns null.
069: */
070: Locator getLocation();
071:
072: /**
073: * Marks this declaration to be acknowledged -- either actually
074: * used or the existence is admitted (for example when
075: * a property customization is given at the point of definition.)
076: *
077: * <p>
078: * Declarations that are not acknowledged will be considered
079: * as an error.
080: */
081: void markAsAcknowledged();
082:
083: /**
084: * Checks if this declaration was acknowledged.
085: */
086: boolean isAcknowledged();
087:
088: /**
089: * Called when the parent {@link BindInfo} got its owner set.
090: *
091: * This is when declarations are connected to {@link BGMBuilder} and
092: * its sibling components.
093: */
094: void onSetOwner();
095:
096: /**
097: * Gets child {@link BIDeclaration}s if any.
098: *
099: * @return
100: * can be empty but always non-null. read-only.
101: */
102: Collection<BIDeclaration> getChildren();
103: }
|