EclipseLink 2.3.2, build 'v20111125-r10461' API Reference

org.eclipse.persistence.jaxb
Class TypeMappingInfo

java.lang.Object
  extended by org.eclipse.persistence.jaxb.TypeMappingInfo

public class TypeMappingInfo
extends java.lang.Object

Purpose: Provides a wrapper for a java type to be used when creating a JAXB context. This allows for additional information (such as parameter level annotations and element tag names) to be included in addition to the type itself.

Author:
mmacivor

Nested Class Summary
static class TypeMappingInfo.ElementScope
           
 
Constructor Summary
TypeMappingInfo()
           
 
Method Summary
 java.lang.annotation.Annotation[] getAnnotations()
          Representing parameter level annotations that should be applied to this type.
 TypeMappingInfo.ElementScope getElementScope()
          Indicates if a global element should be generated for this type.
 java.lang.reflect.Type getType()
          The type to be bound.
 org.w3c.dom.Element getXmlElement()
          Returns the xml-element as a Element which represents the parameter level annotations that should be applied to this type.
 javax.xml.namespace.QName getXmlTagName()
          Root element name associated with this type;
 boolean isNillable()
          Return if the global element will be marked as nillable
 void setAnnotations(java.lang.annotation.Annotation[] annotations)
           
 void setElementScope(TypeMappingInfo.ElementScope scope)
           
 void setNillable(boolean nillable)
          Set if the global element should be marked as nillable
 void setType(java.lang.reflect.Type t)
           
 void setXmlElement(org.w3c.dom.Element xmlElement)
          Set the xml-element Element representing parameter level annotations that should be applied to this type.
 void setXmlTagName(javax.xml.namespace.QName tagName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TypeMappingInfo

public TypeMappingInfo()
Method Detail

getElementScope

public TypeMappingInfo.ElementScope getElementScope()
Indicates if a global element should be generated for this type.


setElementScope

public void setElementScope(TypeMappingInfo.ElementScope scope)

isNillable

public boolean isNillable()
Return if the global element will be marked as nillable

Returns:

setNillable

public void setNillable(boolean nillable)
Set if the global element should be marked as nillable

Parameters:
nillable -

getXmlTagName

public javax.xml.namespace.QName getXmlTagName()
Root element name associated with this type;


setXmlTagName

public void setXmlTagName(javax.xml.namespace.QName tagName)

getType

public java.lang.reflect.Type getType()
The type to be bound.


setType

public void setType(java.lang.reflect.Type t)

getAnnotations

public java.lang.annotation.Annotation[] getAnnotations()
Representing parameter level annotations that should be applied to this type.


setAnnotations

public void setAnnotations(java.lang.annotation.Annotation[] annotations)

getXmlElement

public org.w3c.dom.Element getXmlElement()
Returns the xml-element as a Element which represents the parameter level annotations that should be applied to this type.

Returns:
Element which represents the parameter level annotations that should be applied to this type if set, otherwise null

setXmlElement

public void setXmlElement(org.w3c.dom.Element xmlElement)
Set the xml-element Element representing parameter level annotations that should be applied to this type. If xmlElement is non-null, any annotations set on this instance will be completely ignored. The following XML representations of parameter level annotations will be supported:

Parameters:
xmlElement - Element created from an xml-element
See Also:
Element, XmlElement

EclipseLink 2.3.2, build 'v20111125-r10461' API Reference