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

java.lang.Object
  extended by com.sun.tools.xjc.reader.xmlschema.bindinfo.BIConversion
All Implemented Interfaces:
BIDeclaration
Direct Known Subclasses:
BIConversion.Static, BIConversion.User, BIConversion.UserAdapter

public abstract class BIConversion
extends java.lang.Object

Conversion declaration.

A conversion declaration specifies how an XML type gets mapped to a Java type.


Nested Class Summary
static class BIConversion.Static
          Implementation that returns a statically-determined constant TypeUse.
static class BIConversion.User
          User-specified <javaType> customization.
static class BIConversion.UserAdapter
           
 
Field Summary
static javax.xml.namespace.QName NAME
          Name of the conversion declaration.
protected  BindInfo parent
           
 
Constructor Summary
protected BIConversion()
           
  BIConversion(org.xml.sax.Locator loc)
          Deprecated. 
 
Method Summary
protected  BGMBuilder getBuilder()
           
 java.util.Collection<BIDeclaration> getChildren()
          Gets child BIDeclarations if any.
protected  com.sun.codemodel.JCodeModel getCodeModel()
           
 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()
           
abstract  TypeUse getTypeUse(com.sun.xml.xsom.XSSimpleType owner)
          Gets the TypeUse object that this conversion represents.
 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 javax.xml.namespace.QName NAME
Name of the conversion declaration.


parent

protected BindInfo parent
Constructor Detail

BIConversion

@Deprecated
public BIConversion(org.xml.sax.Locator loc)
Deprecated. 


BIConversion

protected BIConversion()
Method Detail

getTypeUse

public abstract TypeUse getTypeUse(com.sun.xml.xsom.XSSimpleType owner)
Gets the TypeUse object that this conversion represents.

The returned TypeUse object is properly adapted.

Parameters:
owner - A BIConversion is always associated with one XSSimpleType, but that's not always available when a BIConversion is built. So we pass this as a parameter to this method.

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