BIGlobalBinding (Red Hat JBoss Enterprise Application Platform 7.4.0.GA public API)

java.lang.Object
- com.sun.tools.xjc.reader.xmlschema.bindinfo.BIGlobalBinding

All Implemented Interfaces:

BIDeclaration
```
public final class BIGlobalBinding
extends 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.

Author:

Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

Field Summary

Fields
Modifier and Type	Field and Description
`static QName`	`NAME`
`NameConverter`	`nameConverter` Gets the name converter that will govern the `XML -> Java` name conversion process for this compilation.
`protected BindInfo`	`parent`

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`BIGlobalBinding()` Creates a bind info object with the default values

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canBeMappedToTypeSafeEnum(QName typeName)` Checks if the given XML Schema built-in type can be mapped to a type-safe enum class.
`boolean`	`canBeMappedToTypeSafeEnum(String nsUri, String localName)`
`boolean`	`canBeMappedToTypeSafeEnum(XSDeclaration decl)`
`void`	`dispatchGlobalConversions(XSSchemaSet schema)` Moves global BIConversion to the right object.
`void`	`errorCheck()` Performs error check
`protected BGMBuilder`	`getBuilder()`
`Collection<BIDeclaration>`	`getChildren()` Gets child `BIDeclaration`s if any.
`ImplStructureStrategy`	`getCodeGenerationStrategy()`
`protected JCodeModel`	`getCodeModel()`
`int`	`getDefaultEnumMemberSizeCap()`
`BIProperty`	`getDefaultProperty()`
`EnumMemberMode`	`getEnumMemberMode()`
`LocalScoping`	`getFlattenClasses()`
`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()`
`BISerializable`	`getSerializable()`
`JDefinedClass`	`getSuperClass()`
`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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - nameConverter
```
public 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 QName NAME
```
  - parent
```
protected BindInfo parent
```
- Constructor Detail
  - BIGlobalBinding
```
public BIGlobalBinding()
```
    Creates a bind info object with the default values
- Method Detail
  - getSuperClass
```
public JDefinedClass getSuperClass()
```
  - getSuperInterface
```
public 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(XSSchemaSet schema)
```
    Moves global BIConversion to the right object.
  - canBeMappedToTypeSafeEnum
```
public boolean canBeMappedToTypeSafeEnum(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(String nsUri,
                                         String localName)
```
  - canBeMappedToTypeSafeEnum
```
public boolean canBeMappedToTypeSafeEnum(XSDeclaration decl)
```
  - 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.
  - isEqual
```
public boolean isEqual(BIGlobalBinding b)
```
  - 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
  - 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

Class BIGlobalBinding

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

nameConverter

NAME

parent

Constructor Detail

BIGlobalBinding

Method Detail

getSuperClass

getSuperInterface

getDefaultProperty

isJavaNamingConventionEnabled

getSerializable

isGenerateElementClass

isGenerateMixedExtensions

isChoiceContentPropertyEnabled

getDefaultEnumMemberSizeCap

isSimpleMode

isRestrictionFreshType

getEnumMemberMode

isSimpleTypeSubstitution

getCodeGenerationStrategy

getFlattenClasses

errorCheck

onSetOwner

setParent

dispatchGlobalConversions

canBeMappedToTypeSafeEnum

canBeMappedToTypeSafeEnum

canBeMappedToTypeSafeEnum

getName

isEqual

getLocation

getOwner

getBuilder

getCodeModel

isAcknowledged

getChildren

markAsAcknowledged