Package com.sun.tools.xjc.reader.xmlschema.bindinfo

Interface BIDeclaration

All Known Implementing Classes:
BIClass, BIConversion, BIConversion.Static, BIConversion.User, BIConversion.UserAdapter, BIDom, BIEnum, BIEnumMember, BIFactoryMethod, BIGlobalBinding, BIInlineBinaryData, BIProperty, BISchemaBinding, BIXDom, BIXPluginCustomization, BIXSubstitutable
public interface BIDeclaration
Base interface for all binding customization declarations.

Because of the setParent method, one customization declaration can be attached to one component alone.

Author:
Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

  • Method Summary

    Modifier and Type
    Method
    Description
    Collection<BIDeclaration>
    getChildren()
    Gets child BIDeclarations if any.
    Locator
    getLocation()
    Gets the source location where this declaration was written.
    QName
    getName()
    Gets the name of this binding declaration, which is the same as the tag name of the binding element.
    boolean
    isAcknowledged()
    Checks if this declaration was acknowledged.
    void
    markAsAcknowledged()
    Marks this declaration to be acknowledged -- either actually used or the existence is admitted (for example when a property customization is given at the point of definition.)
    void
    onSetOwner()
    Called when the parent BindInfo got its owner set.
    void
    setParent(BindInfo parent)
    Sets the parent BindInfo object of this declaration.

  • Method Details

    • setParent

      void setParent(BindInfo parent)
      Sets the parent BindInfo object of this declaration. A declaration object can use this pointer to access context information, such as other customizations.

      This method can be only called from BindInfo, and only once. This is a good opportunity to do some follow-up initialization after JAXB unmarshalling populated BIDeclaration.

    • getName

      QName getName()
      Gets the name of this binding declaration, which is the same as the tag name of the binding element.

    • getLocation

      Locator getLocation()
      Gets the source location where this declaration was written. For declarations that are generated by XJC itself, this method returns null.

    • markAsAcknowledged

      void markAsAcknowledged()
      Marks this declaration to be acknowledged -- either actually used or the existence is admitted (for example when a property customization is given at the point of definition.)

      Declarations that are not acknowledged will be considered as an error.

    • isAcknowledged

      boolean isAcknowledged()
      Checks if this declaration was acknowledged.

    • onSetOwner

      void onSetOwner()
      Called when the parent BindInfo got its owner set. This is when declarations are connected to BGMBuilder and its sibling components.

    • getChildren

      Collection<BIDeclaration> getChildren()
      Gets child BIDeclarations if any.
      Returns:
      can be empty but always non-null. read-only.