Module org.glassfish.jaxb.xjc

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

Class BISchemaBinding

java.lang.Object

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

All Implemented Interfaces:

BIDeclaration

public final class BISchemaBinding
extends Object

Schema-wide binding customization.

Author:

Kohsuke Kawaguchi ([email protected])

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BISchemaBinding.NamingRule	Default naming rules of the generated interfaces.

Field Summary

Fields

Modifier and Type	Field	Description
boolean	map	If false, it means not to generate any classes from this namespace.
static QName	NAME
protected BindInfo	parent

Constructor Summary

Constructors

Constructor	Description
BISchemaBinding()	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected BGMBuilder	getBuilder()
Collection<BIDeclaration>	getChildren()	Gets child s if any.
protected JCodeModel	getCodeModel()
String	getJavadoc()
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	getPackageName()
boolean	isAcknowledged()	Checks if this declaration was acknowledged.
String	mangleAnonymousTypeClassName(String name)
String	mangleClassName(String name, XSComponent cmp)	Transforms the default name produced from XML name by following the customization.
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

map

public boolean map

If false, it means not to generate any classes from this namespace. No ObjectFactory, no classes (the only way to bind them is by using <jaxb:class ref="..."/>)

NAME

public static final QName NAME

parent

protected BindInfo parent

Constructor Detail

BISchemaBinding

public BISchemaBinding()

Default constructor.

Method Detail

mangleClassName

public String mangleClassName(String name,
                              XSComponent cmp)

Transforms the default name produced from XML name by following the customization. This shouldn't be applied to a class name specified by a customization.

Parameters:

cmp - The schema component from which the default name is derived.

mangleAnonymousTypeClassName

public String mangleAnonymousTypeClassName(String name)

getPackageName

public String getPackageName()

getJavadoc

public String getJavadoc()

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.

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

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 .

Specified by:

setParent 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 s 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