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

Interface BIDeclaration

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.

Method Summary
Collection<BIDeclaration>getChildren()
Gets child BIDeclarations if any.
LocatorgetLocation()
Gets the source location where this declaration was written.
QNamegetName()
Gets the name of this binding declaration, which is the same as the tag name of the binding element.
booleanisAcknowledged()
Checks if this declaration was acknowledged.
voidmarkAsAcknowledged()
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.)
voidonSetOwner()
Called when the parent BindInfo got its owner set.
voidsetParent(BindInfo parent)
Sets the parent BindInfo object of this declaration.

Method Detail

getChildren

public Collection<BIDeclaration> getChildren()
Gets child BIDeclarations if any.

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

getLocation

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

getName

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

isAcknowledged

public boolean isAcknowledged()
Checks if this declaration was acknowledged.

markAsAcknowledged

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.

onSetOwner

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

setParent

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