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

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

public final class BIGlobalBinding
extends java.lang.Object

Global binding customization. The code is highly temporary.

One of the information contained in a global customization is the default binding for properties. This object contains a BIProperty object to keep this information.


Field Summary
static javax.xml.namespace.QName NAME
           
 com.sun.xml.bind.api.impl.NameConverter nameConverter
          Gets the name converter that will govern the XML->Java name conversion process for this compilation.
 
Constructor Summary
BIGlobalBinding()
          Creates a bind info object with the default values
 
Method Summary
 boolean canBeMappedToTypeSafeEnum(javax.xml.namespace.QName typeName)
          Checks if the given XML Schema built-in type can be mapped to a type-safe enum class.
 boolean canBeMappedToTypeSafeEnum(java.lang.String nsUri, java.lang.String localName)
           
 boolean canBeMappedToTypeSafeEnum(com.sun.xml.xsom.XSDeclaration decl)
           
 void dispatchGlobalConversions(com.sun.xml.xsom.XSSchemaSet schema)
          Moves global BIConversion to the right object.
 void errorCheck()
          Performs error check
 java.util.Collection<BIDeclaration> getChildren()
          Gets child BIDeclarations if any.
 ImplStructureStrategy getCodeGenerationStrategy()
           
 int getDefaultEnumMemberSizeCap()
           
 BIProperty getDefaultProperty()
           
 EnumMemberMode getEnumMemberMode()
           
 LocalScoping getFlattenClasses()
           
 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.
 BISerializable getSerializable()
           
 com.sun.codemodel.JDefinedClass getSuperClass()
           
 com.sun.codemodel.JDefinedClass getSuperInterface()
           
 boolean isAcknowledged()
          Checks if this declaration was acknowledged.
 boolean isChoiceContentPropertyEnabled()
           
 boolean isEqual(BIGlobalBinding b)
           
 boolean isGenerateElementClass()
           
 boolean isGenerateMixedExtensions()
           
 boolean isJavaNamingConventionEnabled()
           
 boolean isRestrictionFreshType()
           
 boolean isSimpleMode()
           
 boolean isSimpleTypeSubstitution()
           
 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 parent)
          Sets the parent BindInfo object of this declaration.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

nameConverter

public com.sun.xml.bind.api.impl.NameConverter nameConverter
Gets the name converter that will govern the XML->Java name conversion process for this compilation.

The "underscoreBinding" customization will determine the exact object returned from this method. The rest of XJC should just use the NameConverter interface.

Always non-null.


NAME

public static final javax.xml.namespace.QName NAME
Constructor Detail

BIGlobalBinding

public BIGlobalBinding()
Creates a bind info object with the default values

Method Detail

getSuperClass

public com.sun.codemodel.JDefinedClass getSuperClass()

getSuperInterface

public com.sun.codemodel.JDefinedClass getSuperInterface()

getDefaultProperty

public BIProperty getDefaultProperty()

isJavaNamingConventionEnabled

public boolean isJavaNamingConventionEnabled()

getSerializable

public BISerializable getSerializable()

isGenerateElementClass

public boolean isGenerateElementClass()

isGenerateMixedExtensions

public boolean isGenerateMixedExtensions()

isChoiceContentPropertyEnabled

public boolean isChoiceContentPropertyEnabled()

getDefaultEnumMemberSizeCap

public int getDefaultEnumMemberSizeCap()

isSimpleMode

public boolean isSimpleMode()

isRestrictionFreshType

public boolean isRestrictionFreshType()

getEnumMemberMode

public EnumMemberMode getEnumMemberMode()

isSimpleTypeSubstitution

public boolean isSimpleTypeSubstitution()

getCodeGenerationStrategy

public ImplStructureStrategy getCodeGenerationStrategy()

getFlattenClasses

public LocalScoping getFlattenClasses()

errorCheck

public void errorCheck()
Performs error check


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

setParent

public void setParent(BindInfo parent)
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

dispatchGlobalConversions

public void dispatchGlobalConversions(com.sun.xml.xsom.XSSchemaSet schema)
Moves global BIConversion to the right object.


canBeMappedToTypeSafeEnum

public boolean canBeMappedToTypeSafeEnum(javax.xml.namespace.QName typeName)
Checks if the given XML Schema built-in type can be mapped to a type-safe enum class.

Parameters:
typeName -

canBeMappedToTypeSafeEnum

public boolean canBeMappedToTypeSafeEnum(java.lang.String nsUri,
                                         java.lang.String localName)

canBeMappedToTypeSafeEnum

public boolean canBeMappedToTypeSafeEnum(com.sun.xml.xsom.XSDeclaration decl)

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.


isEqual

public boolean isEqual(BIGlobalBinding b)

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

isAcknowledged

public final boolean isAcknowledged()
Description copied from interface: BIDeclaration
Checks if this declaration was acknowledged.

Specified by:
isAcknowledged 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