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

Class BIClass

java.lang.Object

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

All Implemented Interfaces:

BIDeclaration

public final class BIClass
extends Object

Class declaration. This customization turns arbitrary schema component into a Java content interface.

This customization is acknowledged by the ClassSelector.

Author:

Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

Field Summary

Fields

Modifier and Type	Field and Description
static QName	NAME Name of this declaration.
protected BindInfo	parent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BIClass()

Method Summary

Modifier and Type	Method and Description
protected BGMBuilder	getBuilder()
Collection<BIDeclaration>	getChildren() Gets child BIDeclarations if any.
String	getClassName() Gets the specified class name, or null if not specified.
protected JCodeModel	getCodeModel()
String	getExistingClassRef() Reference to the existing class, or null.
String	getJavadoc() Gets the javadoc comment specified in the customization.
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.
protected XSComponent	getOwner()
String	getRecursive()
String	getUserSpecifiedImplClass() Gets the fully qualified name of the user-specified implementation class, if any.
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 p) Sets the parent BindInfo object of this declaration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final QName NAME

Name of this declaration.

parent

protected BindInfo parent

Constructor Detail

BIClass

protected BIClass()

Method Detail

getClassName

@Nullable
public String getClassName()

Gets the specified class name, or null if not specified. (Not a fully qualified name.)

Returns:

Returns a class name. The caller should NOT apply XML-to-Java name conversion to the name returned from this method.

getUserSpecifiedImplClass

public String getUserSpecifiedImplClass()

Gets the fully qualified name of the user-specified implementation class, if any. Or null.

getExistingClassRef

public String getExistingClassRef()

Reference to the existing class, or null. Fully qualified name.

Caller needs to perform error check on this.

getRecursive

public String getRecursive()

getJavadoc

public String getJavadoc()

Gets the javadoc comment specified in the customization. Can be null if none is specified.

getName

public QName getName()

Description copied from interface: BIDeclaration

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

setParent

public void setParent(BindInfo p)

Description copied from interface: BIDeclaration

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.

Specified by:

setParent in interface BIDeclaration

getLocation

public Locator getLocation()

Description copied from interface: BIDeclaration

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

Specified by:

getLocation in interface BIDeclaration

getOwner

protected final XSComponent getOwner()

getBuilder

protected final BGMBuilder getBuilder()

getCodeModel

protected final JCodeModel getCodeModel()

isAcknowledged

public final boolean isAcknowledged()

Description copied from interface: BIDeclaration

Checks if this declaration was acknowledged.

Specified by:

isAcknowledged in interface BIDeclaration

onSetOwner

public void onSetOwner()

Description copied from interface: BIDeclaration

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

Specified by:

onSetOwner in interface BIDeclaration

getChildren

public Collection<BIDeclaration> getChildren()

Description copied from interface: BIDeclaration

Gets child BIDeclarations if any.

Specified by:

getChildren in interface BIDeclaration

Returns:

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

markAsAcknowledged

public void markAsAcknowledged()

Description copied from interface: BIDeclaration

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.

Specified by:

markAsAcknowledged in interface BIDeclaration