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

java.lang.Object
  extended by com.sun.tools.xjc.reader.xmlschema.bindinfo.BISchemaBinding
All Implemented Interfaces:
BIDeclaration

public final class BISchemaBinding
extends java.lang.Object

Schema-wide binding customization.


Nested Class Summary
static class BISchemaBinding.NamingRule
          Default naming rules of the generated interfaces.
 
Field Summary
 boolean map
          If false, it means not to generate any classes from this namespace.
static javax.xml.namespace.QName NAME
           
protected  BindInfo parent
           
 
Constructor Summary
BISchemaBinding()
           
 
Method Summary
protected  BGMBuilder getBuilder()
           
 java.util.Collection<BIDeclaration> getChildren()
          Gets child BIDeclarations if any.
protected  com.sun.codemodel.JCodeModel getCodeModel()
           
 java.lang.String getJavadoc()
           
 org.xml.sax.Locator getLocation()
          Gets the source location where this declaration was written.
 javax.xml.namespace.QName getName()
          Gets the name of this binding declaration, which is the same as the tag name of the binding element.
protected  com.sun.xml.xsom.XSComponent getOwner()
           
 java.lang.String getPackageName()
           
 boolean isAcknowledged()
          Checks if this declaration was acknowledged.
 java.lang.String mangleAnonymousTypeClassName(java.lang.String name)
           
 java.lang.String mangleClassName(java.lang.String name, com.sun.xml.xsom.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 javax.xml.namespace.QName NAME

parent

protected BindInfo parent
Constructor Detail

BISchemaBinding

public BISchemaBinding()
Method Detail

mangleClassName

public java.lang.String mangleClassName(java.lang.String name,
                                        com.sun.xml.xsom.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 java.lang.String mangleAnonymousTypeClassName(java.lang.String name)

getPackageName

public java.lang.String getPackageName()

getJavadoc

public java.lang.String getJavadoc()

getName

public javax.xml.namespace.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 org.xml.sax.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 BIDeclaration.

Specified by:
setParent in interface BIDeclaration

getOwner

protected final com.sun.xml.xsom.XSComponent getOwner()

getBuilder

protected final BGMBuilder getBuilder()

getCodeModel

protected final com.sun.codemodel.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 java.util.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