1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/jaxws_classes/com/sun/tools/internal/xjc/reader/xmlschema/bindinfo/BIDeclaration.java Wed Apr 27 01:27:09 2016 +0800
1.3 @@ -0,0 +1,105 @@
1.4 +/*
1.5 + * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package com.sun.tools.internal.xjc.reader.xmlschema.bindinfo;
1.30 +
1.31 +import java.util.Collection;
1.32 +
1.33 +import javax.xml.namespace.QName;
1.34 +
1.35 +import com.sun.tools.internal.xjc.reader.xmlschema.BGMBuilder;
1.36 +
1.37 +import org.xml.sax.Locator;
1.38 +
1.39 +/**
1.40 + * Base interface for all binding customization declarations.
1.41 + *
1.42 + * <p>
1.43 + * Because of the setParent method, one customization declaration
1.44 + * can be attached to one component alone.
1.45 + *
1.46 + * @author
1.47 + * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
1.48 + */
1.49 +public interface BIDeclaration {
1.50 +
1.51 + /**
1.52 + * Sets the parent BindInfo object of this declaration.
1.53 + * A declaration object can use this pointer to access
1.54 + * context information, such as other customizations.
1.55 + *
1.56 + * <p>
1.57 + * This method can be only called from {@link BindInfo},
1.58 + * and only once. This is a good opportunity to do some
1.59 + * follow-up initialization after JAXB unmarshalling
1.60 + * populated {@link BIDeclaration}.
1.61 + */
1.62 + void setParent( BindInfo parent );
1.63 +
1.64 + /**
1.65 + * Gets the name of this binding declaration,
1.66 + * which is the same as the tag name of the binding element.
1.67 + */
1.68 + QName getName();
1.69 +
1.70 + /**
1.71 + * Gets the source location where this declaration was written.
1.72 + * For declarations that are generated by XJC itself,
1.73 + * this method returns null.
1.74 + */
1.75 + Locator getLocation();
1.76 +
1.77 + /**
1.78 + * Marks this declaration to be acknowledged -- either actually
1.79 + * used or the existence is admitted (for example when
1.80 + * a property customization is given at the point of definition.)
1.81 + *
1.82 + * <p>
1.83 + * Declarations that are not acknowledged will be considered
1.84 + * as an error.
1.85 + */
1.86 + void markAsAcknowledged();
1.87 +
1.88 + /**
1.89 + * Checks if this declaration was acknowledged.
1.90 + */
1.91 + boolean isAcknowledged();
1.92 +
1.93 + /**
1.94 + * Called when the parent {@link BindInfo} got its owner set.
1.95 + *
1.96 + * This is when declarations are connected to {@link BGMBuilder} and
1.97 + * its sibling components.
1.98 + */
1.99 + void onSetOwner();
1.100 +
1.101 + /**
1.102 + * Gets child {@link BIDeclaration}s if any.
1.103 + *
1.104 + * @return
1.105 + * can be empty but always non-null. read-only.
1.106 + */
1.107 + Collection<BIDeclaration> getChildren();
1.108 +}
