|
EclipseLink 2.5.3, build 'v20180808-e38c757' API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.eclipse.persistence.jaxb.compiler.TypeInfo
public class TypeInfo
INTERNAL:
Purpose:Used to store meta data about JAXB 2.0 Annotated classes during schema and mapping generation processes.
Responsibilities:
AnnotationsProcessor,
EnumTypeInfo| Field Summary | |
|---|---|
static XMLNameTransformer |
DEFAULT_NAME_TRANSFORMER
|
| Constructor Summary | |
|---|---|
TypeInfo(Helper helper,
JavaClass javaClass)
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. |
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()
|
org.eclipse.persistence.internal.oxm.mappings.Descriptor |
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'. |
JavaClass |
getJavaClass()
|
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.List<XmlNamedObjectGraph> |
getObjectGraphs()
|
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. |
org.eclipse.persistence.internal.jaxb.AccessorFactoryWrapper |
getPackageLevelXmlAccessorFactory()
|
java.util.List<Property> |
getPredicateProperties()
INTERNAL: Return the list of predicate properties. |
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. |
org.eclipse.persistence.internal.jaxb.AccessorFactoryWrapper |
getXmlAccessorFactory()
|
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 |
hasPredicateProperties()
INTERNAL: Return true if the list of predicate properties hasn't been initialized. |
boolean |
hasPredicateProperty(Property property)
INTERNAL: Return true if the property handed in is a duplicate of any existing predicate 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 |
isLocationAware()
|
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(org.eclipse.persistence.internal.oxm.mappings.Descriptor 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 |
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 |
setJavaClass(JavaClass javaClass)
|
void |
setJavaClassName(java.lang.String javaClassName)
Set the JavaClass name for this typeinfo. |
void |
setLocationAware(boolean value)
|
void |
setMixed(boolean isMixed)
Set mixed content indicator |
void |
setObjectFactoryClassName(java.lang.String factoryClass)
|
void |
setPackageLevelXmlAccessorFactory(org.eclipse.persistence.internal.jaxb.AccessorFactoryWrapper packageLevelXmlAccessorFactory)
|
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 |
setXmlAccessorFactory(org.eclipse.persistence.internal.jaxb.AccessorFactoryWrapper xmlAccessorFactory)
|
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 |
|---|
public static XMLNameTransformer DEFAULT_NAME_TRANSFORMER
| Constructor Detail |
|---|
public TypeInfo(Helper helper,
JavaClass javaClass)
helper - | Method Detail |
|---|
public org.eclipse.persistence.internal.oxm.mappings.Descriptor getDescriptor()
public void setDescriptor(org.eclipse.persistence.internal.oxm.mappings.Descriptor desc)
desc - public org.eclipse.persistence.internal.oxm.schema.model.ComplexType getComplexType()
public void setComplexType(org.eclipse.persistence.internal.oxm.schema.model.ComplexType type)
public org.eclipse.persistence.internal.oxm.schema.model.SimpleType getSimpleType()
public void setSimpleType(org.eclipse.persistence.internal.oxm.schema.model.SimpleType type)
public java.lang.String[] getPropOrder()
public boolean isSetPropOrder()
public void setPropOrder(java.lang.String[] order)
public java.lang.String getClassNamespace()
public void setClassNamespace(java.lang.String namespace)
public boolean isComplexType()
public boolean isMixed()
public void setMixed(boolean isMixed)
public org.eclipse.persistence.internal.oxm.schema.model.TypeDefParticle getCompositor()
public void setCompositor(org.eclipse.persistence.internal.oxm.schema.model.TypeDefParticle particle)
public java.util.ArrayList<java.lang.String> getPropertyNames()
public Property getIDProperty()
public java.util.HashMap<java.lang.String,Property> getProperties()
public void addProperty(java.lang.String name,
Property property)
public void setIDProperty(Property idProperty)
public void setProperties(java.util.ArrayList<Property> properties)
properties - public void orderProperties()
public boolean isEnumerationType()
public boolean isIDSet()
public java.util.ArrayList<Property> getPropertyList()
public java.lang.String getSchemaTypeName()
public void setSchemaTypeName(java.lang.String typeName)
public void setSchema(org.eclipse.persistence.internal.oxm.schema.model.Schema theSchema)
public org.eclipse.persistence.internal.oxm.schema.model.Schema getSchema()
public JavaClass getPackageLevelAdapterClass(JavaClass boundType)
boundType -
public boolean isAnonymousComplexType()
public JavaClass getPackageLevelAdapterClass(java.lang.String boundTypeName)
boundType -
public java.util.HashMap<java.lang.String,JavaClass> getPackageLevelAdaptersByClass()
public void addPackageLevelAdapterClass(JavaClass adapterClass,
JavaClass boundType)
adapterClass - boundType - public boolean hasRootElement()
public boolean hasElementRefs()
public java.lang.String getElementRefsPropName()
public void setElementRefsPropertyName(java.lang.String propName)
public java.lang.String getObjectFactoryClassName()
public void setObjectFactoryClassName(java.lang.String factoryClass)
public java.lang.String getFactoryMethodName()
public void setFactoryMethodName(java.lang.String factoryMethod)
public java.lang.String[] getFactoryMethodParamTypes()
public void setFactoryMethodParamTypes(java.lang.String[] paramTypes)
public boolean isSetXmlValueProperty()
public Property getXmlValueProperty()
public void setXmlValueProperty(Property xmlValueProperty)
public boolean isTransient()
public void setTransient(boolean isTransient)
public java.util.List<Property> getNonTransientPropertiesInPropOrder()
public boolean isSetXmlTransient()
public void setXmlTransient(boolean isTransient)
isTransient - public boolean isSetXmlSeeAlso()
public java.util.List<java.lang.String> getXmlSeeAlso()
public void setXmlSeeAlso(java.util.List<java.lang.String> xmlSeeAlso)
xmlSeeAlso - public boolean isSetXmlRootElement()
public XmlRootElement getXmlRootElement()
public void setXmlRootElement(XmlRootElement xmlRootElement)
xmlRootElement - public boolean isSetXmlType()
public XmlType getXmlType()
public void setXmlType(XmlType xmlType)
xmlType - public boolean isSetXmlAccessType()
public XmlAccessType getXmlAccessType()
public void setXmlAccessType(XmlAccessType xmlAccessType)
xmlAccessType - public boolean isSetXmlAccessOrder()
public XmlAccessOrder getXmlAccessOrder()
public void setXmlAccessOrder(XmlAccessOrder xmlAccessOrder)
xmlAccessOrder - public boolean isPreBuilt()
public void setPreBuilt(boolean isPreBuilt)
public boolean isPostBuilt()
public void setPostBuilt(boolean isPostBuilt)
public boolean isSetXmlJavaTypeAdapter()
XmlJavaTypeAdapterpublic XmlJavaTypeAdapter getXmlJavaTypeAdapter()
XmlJavaTypeAdapterpublic void setXmlJavaTypeAdapter(XmlJavaTypeAdapter xmlJavaTypeAdapter)
xmlJavaTypeAdapter - XmlJavaTypeAdapterpublic java.lang.String getXmlCustomizer()
DescriptorCustomizerpublic void setXmlCustomizer(java.lang.String xmlCustomizerClassName)
xmlCustomizer - DescriptorCustomizerpublic boolean isSetAnyElementPropertyName()
public java.lang.String getAnyElementPropertyName()
public void setAnyElementPropertyName(java.lang.String anyElementPropertyName)
anyElementPropertyName - public boolean isSetAnyAttributePropertyName()
public java.lang.String getAnyAttributePropertyName()
public void setAnyAttributePropertyName(java.lang.String anyAttributePropertyName)
anyAttributePropertyName - public boolean isBinaryDataToBeInlined()
public void setInlineBinaryData(boolean isBinaryDataInlined)
isBinaryDataInlined - public boolean isSetClassExtractorName()
public java.lang.String getClassExtractorName()
public void setClassExtractorName(java.lang.String classExtractorName)
classExtractorName - public java.util.Map<java.lang.Object,java.lang.Object> getUserProperties()
public void setUserProperties(java.util.Map<java.lang.Object,java.lang.Object> userProperties)
userProperties - public java.lang.String getJavaClassName()
public void setJavaClassName(java.lang.String javaClassName)
javaClassName - public java.lang.String getXmlDiscriminatorNode()
public void setXmlDiscriminatorNode(java.lang.String xmlDiscriminatorNode)
xmlDiscriminatorNode - public boolean isSetXmlDiscriminatorNode()
public java.lang.String getXmlDiscriminatorValue()
public void setXmlDiscriminatorValue(java.lang.String xmlDiscriminatorValue)
xmlDiscriminatorValue - public boolean isSetXmlDiscriminatorValue()
public void addXmlKeyProperty(Property xmlKeyProp)
xmlKeyProp - public java.util.List<Property> getXmlKeyProperties()
public boolean hasXmlKeyProperties()
public java.util.Map<java.lang.String,java.util.List<Property>> getAdditionalProperties()
public java.util.HashMap<java.lang.String,Property> getOriginalProperties()
public XmlVirtualAccessMethods getXmlVirtualAccessMethods()
public void setXmlVirtualAccessMethods(XmlVirtualAccessMethods xmlExtensible)
public XMLNameTransformer getXmlNameTransformer()
public void setXmlNameTransformer(XMLNameTransformer xmlNameTransformer)
xmlNameTransformer - public java.util.List<Property> getPredicateProperties()
public boolean hasPredicateProperty(Property property)
public boolean hasPredicateProperties()
public boolean isLocationAware()
public void setLocationAware(boolean value)
public org.eclipse.persistence.internal.jaxb.AccessorFactoryWrapper getXmlAccessorFactory()
public void setXmlAccessorFactory(org.eclipse.persistence.internal.jaxb.AccessorFactoryWrapper xmlAccessorFactory)
public org.eclipse.persistence.internal.jaxb.AccessorFactoryWrapper getPackageLevelXmlAccessorFactory()
public void setPackageLevelXmlAccessorFactory(org.eclipse.persistence.internal.jaxb.AccessorFactoryWrapper packageLevelXmlAccessorFactory)
public java.util.List<XmlNamedObjectGraph> getObjectGraphs()
public JavaClass getJavaClass()
public void setJavaClass(JavaClass javaClass)
|
EclipseLink 2.5.3, build 'v20180808-e38c757' API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||