Top Description Methods
com.sun.tools.xjc.reader.xmlschema.bindinfo

public Interface BIDeclaration

Known Direct Implementers
com.sun.tools.xjc.reader.xmlschema.bindinfo.AbstractDeclarationImpl
Imports
java.util.Collection, javax.xml.namespace.QName, com.sun.tools.xjc.reader.xmlschema.BGMBuilder, org.xml.sax.Locator
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 ([email protected])

Method Summary

Modifier and TypeMethod and Description
public Collection<BIDeclaration>

Returns:

can be empty but always non-null. read-only.
getChildren()

Gets child s if any.

public Locator
getLocation()

Gets the source location where this declaration was written.

public QName
getName()

Gets the name of this binding declaration, which is the same as the tag name of the binding element.

public boolean
isAcknowledged()

Checks if this declaration was acknowledged.

public 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.

public void
onSetOwner()

Called when the parent BindInfo got its owner set.

public void
setParent(BindInfo parent)

Sets the parent BindInfo object of this declaration.

Method Detail

getChildrenback to summary
public Collection<BIDeclaration> getChildren()

Gets child s if any.

Returns:Collection<BIDeclaration>

can be empty but always non-null. read-only.

getLocationback to summary
public Locator getLocation()

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

getNameback to summary
public QName getName()

Gets the name of this binding declaration, which is the same as the tag name of the binding element.

isAcknowledgedback to summary
public boolean isAcknowledged()

Checks if this declaration was acknowledged.

markAsAcknowledgedback to summary
public 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.

onSetOwnerback to summary
public void onSetOwner()

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

setParentback to summary
public 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 .