Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle TopLink
11g Release 1 (11.1.1)

E28847-01


org.eclipse.persistence.jaxb.compiler
Class TypeInfo

java.lang.Object
  extended by org.eclipse.persistence.jaxb.compiler.TypeInfo

Direct Known Subclasses:
EnumTypeInfo

public class TypeInfo
extends java.lang.Object

INTERNAL:

Purpose:Used to store meta data about JAXB 2.0 Annotated classes during schema and mapping generation processes.

Responsibilities:

Since:
Oracle TopLink 11.1.1.0.0
Author:
mmacivor
See Also:
AnnotationsProcessor, EnumTypeInfo

Field Summary
private  java.util.Map<java.lang.String,java.util.List<Property>> additionalProperties
           
private  java.lang.String anyAttributePropertyName
           
private  java.lang.String anyElementPropertyName
           
private  java.lang.String classExtractorName
           
private  java.lang.String classNamespace
           
private  org.eclipse.persistence.internal.oxm.schema.model.ComplexType complexType
           
private  org.eclipse.persistence.internal.oxm.schema.model.TypeDefParticle compositor
           
static XMLNameTransformer DEFAULT_NAME_TRANSFORMER
           
private  XMLDescriptor descriptor
           
private  java.lang.String elementRefsPropertyName
           
private static java.lang.String EMPTY_STRING
           
private  java.lang.String factoryMethodName
           
private  java.lang.String[] factoryMethodParamTypes
           
private  boolean hasRootElement
           
private  Property idProperty
           
private  boolean isBinaryDataInlined
           
private  boolean isMixed
           
private  boolean isPostBuilt
           
private  boolean isPreBuilt
           
private  boolean isSetXmlTransient
           
private  boolean isTransient
           
private  java.lang.String javaClassName
           
private  java.lang.String objectFactoryClassName
           
private  java.util.HashMap<java.lang.String,Property> originalProperties
           
private  java.util.HashMap<java.lang.String,JavaClass> packageLevelAdaptersByClass
           
private  java.util.HashMap<java.lang.String,Property> properties
           
private  java.util.ArrayList<Property> propertyList
           
private  java.util.ArrayList<java.lang.String> propertyNames
           
private  java.util.ArrayList<java.lang.String> propOrder
           
private  org.eclipse.persistence.internal.oxm.schema.model.Schema schema
           
private  java.lang.String schemaTypeName
           
private  org.eclipse.persistence.internal.oxm.schema.model.SimpleType simpleType
           
private  java.util.Map<java.lang.Object,java.lang.Object> userProperties
           
private  XmlAccessOrder xmlAccessOrder
           
private  XmlAccessType xmlAccessType
           
private  java.lang.String xmlCustomizer
           
private  java.lang.String xmlDiscriminatorNode
           
private  java.lang.String xmlDiscriminatorValue
           
private  XmlVirtualAccessMethods xmlExtensible
           
private  XmlJavaTypeAdapter xmlJavaTypeAdapter
           
private  java.util.List<Property> xmlKeyProperties
           
private  XMLNameTransformer xmlNameTransformer
           
private  XmlRootElement xmlRootElement
           
private  java.util.List<java.lang.String> xmlSeeAlso
           
private  XmlType xmlType
           
private  Property xmlValueProperty
           

 

Constructor Summary
TypeInfo(Helper helper)
          This constructor sets the Helper to be used throughout XML and Annotations processing.

 

Method Summary
 void addPackageLevelAdapterClass(JavaClass adapterClass, JavaClass boundType)
          Put a bound type class to adapter class entry in the Map.
 void addProperty(java.lang.String name, Property property)
          Put a Property in the Map of Properties for this TypeInfo.
private  void addPropertyToList(java.util.List<Property> propertiesInOrder, java.lang.String propertyName, java.util.ArrayList<java.lang.String> propertyNamesCopy)
          Convenience method that adds non-null, non-transient properties to a given List<Property>.
 void addXmlKeyProperty(Property xmlKeyProp)
          Add an XmlKey property to the list.
 java.util.Map<java.lang.String,java.util.List<Property>> getAdditionalProperties()
          Return a Map of property names to list of properties.
 java.lang.String getAnyAttributePropertyName()
          Return the name of the XmlAnyAttribute property, if one is set.
 java.lang.String getAnyElementPropertyName()
          Return the name of the XmlAnyElement property, if one is set.
 java.lang.String getClassExtractorName()
          Return the ClassExtractor class name.
 java.lang.String getClassNamespace()
           
 org.eclipse.persistence.internal.oxm.schema.model.ComplexType getComplexType()
           
 org.eclipse.persistence.internal.oxm.schema.model.TypeDefParticle getCompositor()
           
 XMLDescriptor getDescriptor()
          Return the XmlDescriptor set on this TypeInfo.
 java.lang.String getElementRefsPropName()
          Return the XmlElementRefs property name, if one has been set.
 java.lang.String getFactoryMethodName()
           
 java.lang.String[] getFactoryMethodParamTypes()
           
 Property getIDProperty()
          Return the TypeProperty 'idProperty'.
 java.lang.String getJavaClassName()
          Return the JavaClass name for this typeinfo.
 java.util.List<Property> getNonTransientPropertiesInPropOrder()
          Return all non-transient properties that exist in the propOrder array.
 java.lang.String getObjectFactoryClassName()
           
 java.util.HashMap<java.lang.String,Property> getOriginalProperties()
          Return the list of original properties for this type info.
 JavaClass getPackageLevelAdapterClass(JavaClass boundType)
          Return the xmladapter class for a given bound type class.
 JavaClass getPackageLevelAdapterClass(java.lang.String boundTypeName)
          Return the xmladapter class for a given bound type class name.
 java.util.HashMap<java.lang.String,JavaClass> getPackageLevelAdaptersByClass()
          Return the Map of XmlAdapters for this TypeInfo.
 java.util.HashMap<java.lang.String,Property> getProperties()
          Return the Map of Properties for this TypeInfo.
 java.util.ArrayList<Property> getPropertyList()
           
 java.util.ArrayList<java.lang.String> getPropertyNames()
           
 java.lang.String[] getPropOrder()
           
 org.eclipse.persistence.internal.oxm.schema.model.Schema getSchema()
           
 java.lang.String getSchemaTypeName()
           
 org.eclipse.persistence.internal.oxm.schema.model.SimpleType getSimpleType()
           
 java.util.Map<java.lang.Object,java.lang.Object> getUserProperties()
          Return the Map of user-defined properties.
 XmlAccessOrder getXmlAccessOrder()
          Return the xmlAccessOrder for this TypeInfo.
 XmlAccessType getXmlAccessType()
          Return the xmlAccessType for this TypeInfo.
 java.lang.String getXmlCustomizer()
          Return the XmlCustomizer class name set on this TypeInfo, or null if none is set.
 java.lang.String getXmlDiscriminatorNode()
          Return the class indicator field name for this type info.
 java.lang.String getXmlDiscriminatorValue()
          Return the value of the class indicator field for the java-type associated with this type info.
 XmlJavaTypeAdapter getXmlJavaTypeAdapter()
          Return the xmlJavaTypeAdapter set on this Type.
 java.util.List<Property> getXmlKeyProperties()
          Return the list of XmlKey property entries.
 XMLNameTransformer getXmlNameTransformer()
          Return the XMLNameTransformer used when converting Java names to XML names
 XmlRootElement getXmlRootElement()
          Return the xmlRootElement set on this TypeInfo.
 java.util.List<java.lang.String> getXmlSeeAlso()
          Return the List of XmlSeeAlso class names for this TypeInfo.
 XmlType getXmlType()
          Return the xmlType set on this TypeInfo.
 Property getXmlValueProperty()
           
 XmlVirtualAccessMethods getXmlVirtualAccessMethods()
           
 boolean hasElementRefs()
          Indicates if this TypeInfo contains an XmlElementRefs property.
 boolean hasRootElement()
           
 boolean hasXmlKeyProperties()
          Indicates if the list of XmlKey property entries has been set, i.e. is non-null.
 boolean isAnonymousComplexType()
           
 boolean isBinaryDataToBeInlined()
          Indicates if all binary data types are to be inlined for this class.
 boolean isComplexType()
           
 boolean isEnumerationType()
          Indicates if this type info represents an enumeration.
 boolean isIDSet()
          Indicates if an @XmlID is set on a field/property.
 boolean isMixed()
          Indicates mixed content
 boolean isPostBuilt()
          Indicates if this TypeInfo has completed the postBuildTypeInfo phase of processing.
 boolean isPreBuilt()
          Indicates if this TypeInfo has completed the preBuildTypeInfo phase of processing.
 boolean isSetAnyAttributePropertyName()
          Indicates if the name of the XmlAnyAttribute property has been set.
 boolean isSetAnyElementPropertyName()
          Indicates if the name of the XmlAnyElement property has been set.
 boolean isSetClassExtractorName()
          Indicates if a ClassExtractor class name is set, i.e. is non-null
 boolean isSetPropOrder()
          Indicates that the propOrder has been set, i.e. is non-null
 boolean isSetXmlAccessOrder()
          Indicates if xmlAccessOrder has been set, i.e. is non-null
 boolean isSetXmlAccessType()
          Indicates if xmlAccessType has been set, i.e. is non-null
 boolean isSetXmlDiscriminatorNode()
          Indicates if the class indicator field name is set, i.e. is non-null
 boolean isSetXmlDiscriminatorValue()
          Indicates if a class indicator field value has been set, i.e. is non-null
 boolean isSetXmlJavaTypeAdapter()
          Indicates if an XmlJavaTypeAdapter has been set, i.e. the xmlJavaTypeAdapter property is non-null.
 boolean isSetXmlRootElement()
          Indicates if xmlRootElement has been set, i.e. is non-null
 boolean isSetXmlSeeAlso()
          Indicates if xmlSeeAlso has been set, i.e. is non-null
 boolean isSetXmlTransient()
          Indicates if XmlTransient is set.
 boolean isSetXmlType()
          Indicates if xmlType has been set, i.e. is non-null
 boolean isSetXmlValueProperty()
          Indicates if an xmlValueProperty is set on this TypeInfo, i.e.
 boolean isTransient()
          Indicates if the class represented by this TypeInfo is marked XmlTransient.
 void orderProperties()
          Order the properties based on the XmlAccessOrder, if set.
 void setAnyAttributePropertyName(java.lang.String anyAttributePropertyName)
          Set the name of the XmlAnyAttribute property
 void setAnyElementPropertyName(java.lang.String anyElementPropertyName)
          Set the name of the XmlAnyElement property
 void setClassExtractorName(java.lang.String classExtractorName)
          Set the ClassExtractor class name.
 void setClassNamespace(java.lang.String namespace)
           
 void setComplexType(org.eclipse.persistence.internal.oxm.schema.model.ComplexType type)
           
 void setCompositor(org.eclipse.persistence.internal.oxm.schema.model.TypeDefParticle particle)
           
 void setDescriptor(XMLDescriptor desc)
          Set the XmlDescriptor on this TypeInfo.
 void setElementRefsPropertyName(java.lang.String propName)
          Set the XmlElementRefs property name.
 void setFactoryMethodName(java.lang.String factoryMethod)
           
 void setFactoryMethodParamTypes(java.lang.String[] paramTypes)
           
 void setHasRootElement(boolean hasRoot)
           
 void setIDProperty(Property idProperty)
          Sets the TypeProperty 'idProperty'.
 void setInlineBinaryData(boolean isBinaryDataInlined)
          Sets the flag that indicates if all binary data types are to be inlined for this class.
 void setJavaClassName(java.lang.String javaClassName)
          Set the JavaClass name for this typeinfo.
 void setMixed(boolean isMixed)
          Set mixed content indicator
 void setObjectFactoryClassName(java.lang.String factoryClass)
           
 void setPostBuilt(boolean isPostBuilt)
          Set indicator that this TypeInfo has completed the postBuildTypeInfo phase of processing.
 void setPreBuilt(boolean isPreBuilt)
          Set indicator that this TypeInfo has completed the preBuildTypeInfo phase of processing.
 void setProperties(java.util.ArrayList<Property> properties)
          Set the Map of Properties for this TypeInfo.
 void setPropOrder(java.lang.String[] order)
           
 void setSchema(org.eclipse.persistence.internal.oxm.schema.model.Schema theSchema)
           
 void setSchemaTypeName(java.lang.String typeName)
           
 void setSimpleType(org.eclipse.persistence.internal.oxm.schema.model.SimpleType type)
           
 void setTransient(boolean isTransient)
          Used to indicate that the class represented by this TypeInfo is marked XmlTransient.
 void setUserProperties(java.util.Map<java.lang.Object,java.lang.Object> userProperties)
          Set the Map of user-defined properties.
 void setXmlAccessOrder(XmlAccessOrder xmlAccessOrder)
          Set the xmlAccessOrder for this TypeInfo.
 void setXmlAccessType(XmlAccessType xmlAccessType)
          Set the xmlAccessType for this TypeInfo.
 void setXmlCustomizer(java.lang.String xmlCustomizerClassName)
          Sets the XmlCustomizer class name on this TypeInfo.
 void setXmlDiscriminatorNode(java.lang.String xmlDiscriminatorNode)
          Sets the class indicator field name (for use with inheritance).
 void setXmlDiscriminatorValue(java.lang.String xmlDiscriminatorValue)
          Set the value of the class indicator field for the java-type associated with this type info.
 void setXmlJavaTypeAdapter(XmlJavaTypeAdapter xmlJavaTypeAdapter)
          Set an XmlJavaTypeAdapter on this Type.
 void setXmlNameTransformer(XMLNameTransformer xmlNameTransformer)
          Set the XMLNameTransformer used when converting Java names to XML names
 void setXmlRootElement(XmlRootElement xmlRootElement)
          Set the xmlRootElement for this TypeInfo.
 void setXmlSeeAlso(java.util.List<java.lang.String> xmlSeeAlso)
          Set the List of XmlSeeAlso class names for this TypeInfo.
 void setXmlTransient(boolean isTransient)
          Set the XmlTransient for this TypeInfo.
 void setXmlType(XmlType xmlType)
          Set the xmlType for this TypeInfo.
 void setXmlValueProperty(Property xmlValueProperty)
           
 void setXmlVirtualAccessMethods(XmlVirtualAccessMethods xmlExtensible)
           

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

descriptor

private XMLDescriptor descriptor

javaClassName

private java.lang.String javaClassName

complexType

private org.eclipse.persistence.internal.oxm.schema.model.ComplexType complexType

hasRootElement

private boolean hasRootElement

elementRefsPropertyName

private java.lang.String elementRefsPropertyName

schema

private org.eclipse.persistence.internal.oxm.schema.model.Schema schema

simpleType

private org.eclipse.persistence.internal.oxm.schema.model.SimpleType simpleType

propOrder

private java.util.ArrayList<java.lang.String> propOrder

classNamespace

private java.lang.String classNamespace

schemaTypeName

private java.lang.String schemaTypeName

compositor

private org.eclipse.persistence.internal.oxm.schema.model.TypeDefParticle compositor

propertyNames

private java.util.ArrayList<java.lang.String> propertyNames

propertyList

private java.util.ArrayList<Property> propertyList

properties

private java.util.HashMap<java.lang.String,Property> properties

originalProperties

private java.util.HashMap<java.lang.String,Property> originalProperties

additionalProperties

private java.util.Map<java.lang.String,java.util.List<Property>> additionalProperties

idProperty

private Property idProperty

packageLevelAdaptersByClass

private java.util.HashMap<java.lang.String,JavaClass> packageLevelAdaptersByClass

objectFactoryClassName

private java.lang.String objectFactoryClassName

factoryMethodName

private java.lang.String factoryMethodName

factoryMethodParamTypes

private java.lang.String[] factoryMethodParamTypes

xmlValueProperty

private Property xmlValueProperty

classExtractorName

private java.lang.String classExtractorName

userProperties

private java.util.Map<java.lang.Object,java.lang.Object> userProperties

xmlKeyProperties

private java.util.List<Property> xmlKeyProperties

isMixed

private boolean isMixed

isTransient

private boolean isTransient

isPreBuilt

private boolean isPreBuilt

isPostBuilt

private boolean isPostBuilt

isSetXmlTransient

private boolean isSetXmlTransient

xmlSeeAlso

private java.util.List<java.lang.String> xmlSeeAlso

xmlRootElement

private XmlRootElement xmlRootElement

xmlType

private XmlType xmlType

xmlAccessType

private XmlAccessType xmlAccessType

xmlAccessOrder

private XmlAccessOrder xmlAccessOrder

xmlJavaTypeAdapter

private XmlJavaTypeAdapter xmlJavaTypeAdapter

xmlCustomizer

private java.lang.String xmlCustomizer

xmlExtensible

private XmlVirtualAccessMethods xmlExtensible

anyAttributePropertyName

private java.lang.String anyAttributePropertyName

anyElementPropertyName

private java.lang.String anyElementPropertyName

isBinaryDataInlined

private boolean isBinaryDataInlined

xmlDiscriminatorNode

private java.lang.String xmlDiscriminatorNode

xmlDiscriminatorValue

private java.lang.String xmlDiscriminatorValue

EMPTY_STRING

private static java.lang.String EMPTY_STRING

xmlNameTransformer

private XMLNameTransformer xmlNameTransformer

DEFAULT_NAME_TRANSFORMER

public static XMLNameTransformer DEFAULT_NAME_TRANSFORMER

Constructor Detail

TypeInfo

public TypeInfo(Helper helper)
This constructor sets the Helper to be used throughout XML and Annotations processing. Other fields are initialized here as well.
Parameters:
helper -

Method Detail

getDescriptor

public XMLDescriptor getDescriptor()
Return the XmlDescriptor set on this TypeInfo.
Returns:
the XmlDescriptor set on this TypeInfo, or null if none

setDescriptor

public void setDescriptor(XMLDescriptor desc)
Set the XmlDescriptor on this TypeInfo.
Parameters:
desc -

getComplexType

public org.eclipse.persistence.internal.oxm.schema.model.ComplexType getComplexType()

setComplexType

public void setComplexType(org.eclipse.persistence.internal.oxm.schema.model.ComplexType type)

getSimpleType

public org.eclipse.persistence.internal.oxm.schema.model.SimpleType getSimpleType()

setSimpleType

public void setSimpleType(org.eclipse.persistence.internal.oxm.schema.model.SimpleType type)

getPropOrder

public java.lang.String[] getPropOrder()

isSetPropOrder

public boolean isSetPropOrder()
Indicates that the propOrder has been set, i.e. is non-null
Returns:
true if propOrder is non-null, false otherwise

setPropOrder

public void setPropOrder(java.lang.String[] order)

getClassNamespace

public java.lang.String getClassNamespace()

setClassNamespace

public void setClassNamespace(java.lang.String namespace)

isComplexType

public boolean isComplexType()

isMixed

public boolean isMixed()
Indicates mixed content

setMixed

public void setMixed(boolean isMixed)
Set mixed content indicator

getCompositor

public org.eclipse.persistence.internal.oxm.schema.model.TypeDefParticle getCompositor()

setCompositor

public void setCompositor(org.eclipse.persistence.internal.oxm.schema.model.TypeDefParticle particle)

getPropertyNames

public java.util.ArrayList<java.lang.String> getPropertyNames()

getIDProperty

public Property getIDProperty()
Return the TypeProperty 'idProperty'. This method will typically be used in conjunction with isIDSet method to determine if an @XmlID exists, and hence 'idProperty' is non-null.
Returns:

getProperties

public java.util.HashMap<java.lang.String,Property> getProperties()
Return the Map of Properties for this TypeInfo.
Returns:

addProperty

public void addProperty(java.lang.String name,
                        Property property)
Put a Property in the Map of Properties for this TypeInfo. Here, the original property is put in the originalProperties map, the properties map, and the propertyList list. It is assumed that the originalProperties map will remain unchanged during processing.

setIDProperty

public void setIDProperty(Property idProperty)
Sets the TypeProperty 'idProperty'. This indicates that an @XmlID annotation is set on a given field/method.

setProperties

public void setProperties(java.util.ArrayList<Property> properties)
Set the Map of Properties for this TypeInfo.
Parameters:
properties -

orderProperties

public void orderProperties()
Order the properties based on the XmlAccessOrder, if set.

isEnumerationType

public boolean isEnumerationType()
Indicates if this type info represents an enumeration. Since EnumTypeInfo is used for enum types, this method will always return false.
Returns:
false

isIDSet

public boolean isIDSet()
Indicates if an @XmlID is set on a field/property. If so, the TypeProperty 'idProperty' will be non-null.
Returns:

getPropertyList

public java.util.ArrayList<Property> getPropertyList()

getSchemaTypeName

public java.lang.String getSchemaTypeName()

setSchemaTypeName

public void setSchemaTypeName(java.lang.String typeName)

setSchema

public void setSchema(org.eclipse.persistence.internal.oxm.schema.model.Schema theSchema)

getSchema

public org.eclipse.persistence.internal.oxm.schema.model.Schema getSchema()

getPackageLevelAdapterClass

public JavaClass getPackageLevelAdapterClass(JavaClass boundType)
Return the xmladapter class for a given bound type class.
Parameters:
boundType -
Returns:

isAnonymousComplexType

public boolean isAnonymousComplexType()

getPackageLevelAdapterClass

public JavaClass getPackageLevelAdapterClass(java.lang.String boundTypeName)
Return the xmladapter class for a given bound type class name.
Parameters:
boundType -
Returns:

getPackageLevelAdaptersByClass

public java.util.HashMap<java.lang.String,JavaClass> getPackageLevelAdaptersByClass()
Return the Map of XmlAdapters for this TypeInfo.
Returns:

addPackageLevelAdapterClass

public void addPackageLevelAdapterClass(JavaClass adapterClass,
                                        JavaClass boundType)
Put a bound type class to adapter class entry in the Map.
Parameters:
adapterClass -
boundType -

hasRootElement

public boolean hasRootElement()

setHasRootElement

public void setHasRootElement(boolean hasRoot)

hasElementRefs

public boolean hasElementRefs()
Indicates if this TypeInfo contains an XmlElementRefs property.
Returns:

getElementRefsPropName

public java.lang.String getElementRefsPropName()
Return the XmlElementRefs property name, if one has been set.
Returns:

setElementRefsPropertyName

public void setElementRefsPropertyName(java.lang.String propName)
Set the XmlElementRefs property name.

getObjectFactoryClassName

public java.lang.String getObjectFactoryClassName()

setObjectFactoryClassName

public void setObjectFactoryClassName(java.lang.String factoryClass)

getFactoryMethodName

public java.lang.String getFactoryMethodName()

setFactoryMethodName

public void setFactoryMethodName(java.lang.String factoryMethod)

getFactoryMethodParamTypes

public java.lang.String[] getFactoryMethodParamTypes()

setFactoryMethodParamTypes

public void setFactoryMethodParamTypes(java.lang.String[] paramTypes)

isSetXmlValueProperty

public boolean isSetXmlValueProperty()
Indicates if an xmlValueProperty is set on this TypeInfo, i.e. is non-null.
Returns:

getXmlValueProperty

public Property getXmlValueProperty()

setXmlValueProperty

public void setXmlValueProperty(Property xmlValueProperty)

isTransient

public boolean isTransient()
Indicates if the class represented by this TypeInfo is marked XmlTransient.
Returns:

setTransient

public void setTransient(boolean isTransient)
Used to indicate that the class represented by this TypeInfo is marked XmlTransient.

getNonTransientPropertiesInPropOrder

public java.util.List<Property> getNonTransientPropertiesInPropOrder()
Return all non-transient properties that exist in the propOrder array.
Returns:

addPropertyToList

private void addPropertyToList(java.util.List<Property> propertiesInOrder,
                               java.lang.String propertyName,
                               java.util.ArrayList<java.lang.String> propertyNamesCopy)
Convenience method that adds non-null, non-transient properties to a given List<Property>. The propertyName parameter is used to lookup the Property. If propertyNamesCopy is non-null, the Property will be removed from that List. Any additional properties that exist for propertyName (as in the case of multiple mappings to the same field) will be added as well.

isSetXmlTransient

public boolean isSetXmlTransient()
Indicates if XmlTransient is set.
Returns:

setXmlTransient

public void setXmlTransient(boolean isTransient)
Set the XmlTransient for this TypeInfo.
Parameters:
isTransient -

isSetXmlSeeAlso

public boolean isSetXmlSeeAlso()
Indicates if xmlSeeAlso has been set, i.e. is non-null
Returns:
true is xmlSeeAlso has been set, i.e. is non-null, false otherwise

getXmlSeeAlso

public java.util.List<java.lang.String> getXmlSeeAlso()
Return the List of XmlSeeAlso class names for this TypeInfo.
Returns:

setXmlSeeAlso

public void setXmlSeeAlso(java.util.List<java.lang.String> xmlSeeAlso)
Set the List of XmlSeeAlso class names for this TypeInfo.
Parameters:
xmlSeeAlso -

isSetXmlRootElement

public boolean isSetXmlRootElement()
Indicates if xmlRootElement has been set, i.e. is non-null
Returns:
true is xmlRootElement has been set, i.e. is non-null, false otherwise

getXmlRootElement

public XmlRootElement getXmlRootElement()
Return the xmlRootElement set on this TypeInfo.
Returns:

setXmlRootElement

public void setXmlRootElement(XmlRootElement xmlRootElement)
Set the xmlRootElement for this TypeInfo.
Parameters:
xmlRootElement -

isSetXmlType

public boolean isSetXmlType()
Indicates if xmlType has been set, i.e. is non-null
Returns:
true is xmlType has been set, i.e. is non-null, false otherwise

getXmlType

public XmlType getXmlType()
Return the xmlType set on this TypeInfo.
Returns:

setXmlType

public void setXmlType(XmlType xmlType)
Set the xmlType for this TypeInfo.
Parameters:
xmlType -

isSetXmlAccessType

public boolean isSetXmlAccessType()
Indicates if xmlAccessType has been set, i.e. is non-null
Returns:
true is xmlAccessType has been set, i.e. is non-null, false otherwise

getXmlAccessType

public XmlAccessType getXmlAccessType()
Return the xmlAccessType for this TypeInfo.
Returns:

setXmlAccessType

public void setXmlAccessType(XmlAccessType xmlAccessType)
Set the xmlAccessType for this TypeInfo.
Parameters:
xmlAccessType -

isSetXmlAccessOrder

public boolean isSetXmlAccessOrder()
Indicates if xmlAccessOrder has been set, i.e. is non-null
Returns:
true is xmlAccessOrder has been set, i.e. is non-null, false otherwise

getXmlAccessOrder

public XmlAccessOrder getXmlAccessOrder()
Return the xmlAccessOrder for this TypeInfo.
Returns:

setXmlAccessOrder

public void setXmlAccessOrder(XmlAccessOrder xmlAccessOrder)
Set the xmlAccessOrder for this TypeInfo.
Parameters:
xmlAccessOrder -

isPreBuilt

public boolean isPreBuilt()
Indicates if this TypeInfo has completed the preBuildTypeInfo phase of processing.
Returns:
true if this TypeInfo has completed the preBuildTypeInfo phase of processing, false otherwise

setPreBuilt

public void setPreBuilt(boolean isPreBuilt)
Set indicator that this TypeInfo has completed the preBuildTypeInfo phase of processing.

isPostBuilt

public boolean isPostBuilt()
Indicates if this TypeInfo has completed the postBuildTypeInfo phase of processing.
Returns:
true if this TypeInfo has completed the postBuildTypeInfo phase of processing, false otherwise

setPostBuilt

public void setPostBuilt(boolean isPostBuilt)
Set indicator that this TypeInfo has completed the postBuildTypeInfo phase of processing.

isSetXmlJavaTypeAdapter

public boolean isSetXmlJavaTypeAdapter()
Indicates if an XmlJavaTypeAdapter has been set, i.e. the xmlJavaTypeAdapter property is non-null.
Returns:
true if xmlJavaTypeAdapter is non-null, false otherwise
See Also:
XmlJavaTypeAdapter

getXmlJavaTypeAdapter

public XmlJavaTypeAdapter getXmlJavaTypeAdapter()
Return the xmlJavaTypeAdapter set on this Type.
Returns:
xmlJavaTypeAdapter, or null if not set
See Also:
XmlJavaTypeAdapter

setXmlJavaTypeAdapter

public void setXmlJavaTypeAdapter(XmlJavaTypeAdapter xmlJavaTypeAdapter)
Set an XmlJavaTypeAdapter on this Type.
Parameters:
xmlJavaTypeAdapter -
See Also:
XmlJavaTypeAdapter

getXmlCustomizer

public java.lang.String getXmlCustomizer()
Return the XmlCustomizer class name set on this TypeInfo, or null if none is set.
Returns:
the XmlCustomizer class name set on this TypeInfo, or null if none is set
See Also:
DescriptorCustomizer

setXmlCustomizer

public void setXmlCustomizer(java.lang.String xmlCustomizerClassName)
Sets the XmlCustomizer class name on this TypeInfo.
Parameters:
xmlCustomizer -
See Also:
DescriptorCustomizer

isSetAnyElementPropertyName

public boolean isSetAnyElementPropertyName()
Indicates if the name of the XmlAnyElement property has been set.
Returns:

getAnyElementPropertyName

public java.lang.String getAnyElementPropertyName()
Return the name of the XmlAnyElement property, if one is set.
Returns:

setAnyElementPropertyName

public void setAnyElementPropertyName(java.lang.String anyElementPropertyName)
Set the name of the XmlAnyElement property
Parameters:
anyElementPropertyName -

isSetAnyAttributePropertyName

public boolean isSetAnyAttributePropertyName()
Indicates if the name of the XmlAnyAttribute property has been set.
Returns:

getAnyAttributePropertyName

public java.lang.String getAnyAttributePropertyName()
Return the name of the XmlAnyAttribute property, if one is set.
Returns:

setAnyAttributePropertyName

public void setAnyAttributePropertyName(java.lang.String anyAttributePropertyName)
Set the name of the XmlAnyAttribute property
Parameters:
anyAttributePropertyName -

isBinaryDataToBeInlined

public boolean isBinaryDataToBeInlined()
Indicates if all binary data types are to be inlined for this class.
Returns:

setInlineBinaryData

public void setInlineBinaryData(boolean isBinaryDataInlined)
Sets the flag that indicates if all binary data types are to be inlined for this class.
Parameters:
isBinaryDataInlined -

isSetClassExtractorName

public boolean isSetClassExtractorName()
Indicates if a ClassExtractor class name is set, i.e. is non-null
Returns:
true if classExtractorName != null, otherwise false

getClassExtractorName

public java.lang.String getClassExtractorName()
Return the ClassExtractor class name.
Returns:
classExtractorName

setClassExtractorName

public void setClassExtractorName(java.lang.String classExtractorName)
Set the ClassExtractor class name.
Parameters:
classExtractorName -

getUserProperties

public java.util.Map<java.lang.Object,java.lang.Object> getUserProperties()
Return the Map of user-defined properties.
Returns:

setUserProperties

public void setUserProperties(java.util.Map<java.lang.Object,java.lang.Object> userProperties)
Set the Map of user-defined properties.
Parameters:
userProperties -

getJavaClassName

public java.lang.String getJavaClassName()
Return the JavaClass name for this typeinfo.
Returns:

setJavaClassName

public void setJavaClassName(java.lang.String javaClassName)
Set the JavaClass name for this typeinfo.
Parameters:
javaClassName -

getXmlDiscriminatorNode

public java.lang.String getXmlDiscriminatorNode()
Return the class indicator field name for this type info.
Returns:

setXmlDiscriminatorNode

public void setXmlDiscriminatorNode(java.lang.String xmlDiscriminatorNode)
Sets the class indicator field name (for use with inheritance).
Parameters:
xmlDiscriminatorNode -

isSetXmlDiscriminatorNode

public boolean isSetXmlDiscriminatorNode()
Indicates if the class indicator field name is set, i.e. is non-null
Returns:
true if xmlDiscriminatorNode != null, otherwise false

getXmlDiscriminatorValue

public java.lang.String getXmlDiscriminatorValue()
Return the value of the class indicator field for the java-type associated with this type info.
Returns:

setXmlDiscriminatorValue

public void setXmlDiscriminatorValue(java.lang.String xmlDiscriminatorValue)
Set the value of the class indicator field for the java-type associated with this type info.
Parameters:
xmlDiscriminatorValue -

isSetXmlDiscriminatorValue

public boolean isSetXmlDiscriminatorValue()
Indicates if a class indicator field value has been set, i.e. is non-null
Returns:
true if xmlDiscriminatorValue != null, otherwise false

addXmlKeyProperty

public void addXmlKeyProperty(Property xmlKeyProp)
Add an XmlKey property to the list. Each entry will be set as a primary key on the owning descriptor.
Parameters:
xmlKeyProp -

getXmlKeyProperties

public java.util.List<Property> getXmlKeyProperties()
Return the list of XmlKey property entries. Each entry will be set as a primary key on the owning descriptor.
Returns:

hasXmlKeyProperties

public boolean hasXmlKeyProperties()
Indicates if the list of XmlKey property entries has been set, i.e. is non-null.
Returns:

getAdditionalProperties

public java.util.Map<java.lang.String,java.util.List<Property>> getAdditionalProperties()
Return a Map of property names to list of properties. This Map will contain entries when one or more properties exist for a given field, as in the case of multiple mappings for a single field.

getOriginalProperties

public java.util.HashMap<java.lang.String,Property> getOriginalProperties()
Return the list of original properties for this type info. These properties were created during annotations processing, and have not been modified since.
Returns:

getXmlVirtualAccessMethods

public XmlVirtualAccessMethods getXmlVirtualAccessMethods()

setXmlVirtualAccessMethods

public void setXmlVirtualAccessMethods(XmlVirtualAccessMethods xmlExtensible)

getXmlNameTransformer

public XMLNameTransformer getXmlNameTransformer()
Return the XMLNameTransformer used when converting Java names to XML names
Returns:

setXmlNameTransformer

public void setXmlNameTransformer(XMLNameTransformer xmlNameTransformer)
Set the XMLNameTransformer used when converting Java names to XML names
Parameters:
xmlNameTransformer -

Skip navigation links

Copyright © 1998, 2012, Oracle. All Rights Reserved.