org.eclipse.persistence.jaxb.javamodel
Class Helper

java.lang.Object
  extended by org.eclipse.persistence.jaxb.javamodel.Helper

public class Helper
extends Object

INTERNAL:

Purpose:To provide helper methods and constants to assist in integrating TopLink JAXB 2.0 Generation with the JDEV JOT APIs.

Responsibilities:

Since:
Oracle TopLink 11.1.1.0.0
See Also:
org.eclipse.persistence.jaxb20.javamodel.JavaModel, org.eclipse.persistence.jaxb20.javamodel.jot.AnnotationProxy

Field Summary
static String ABYTE
           
static String APBYTE
           
static String BIGDECIMAL
           
static String BIGINTEGER
           
static String BOOLEAN
           
static String BYTE
           
static String CALENDAR
           
static String DOUBLE
           
static String DURATION
           
static String FLOAT
           
static String GREGORIAN_CALENDAR
           
static String INTEGER
           
static String LONG
           
static String PBOOLEAN
           
static String PBYTE
           
static String PDOUBLE
           
static String PFLOAT
           
static String PINT
           
static String PLONG
           
static String PSHORT
           
static String QNAME_CLASS
           
static String SHORT
           
static String SQL_DATE
           
static String SQL_TIME
           
static String SQL_TIMESTAMP
           
static String STRING
           
static String URI
           
static String UTIL_DATE
           
static String UUID
           
static String XMLGREGORIANCALENDAR
           
 
Constructor Summary
Helper(JavaModel model)
          INTERNAL: This is the preferred constructor.
 
Method Summary
 Annotation getAnnotation(JavaHasAnnotations element, Class annotationClass)
          Returns a either a dynamic proxy instance that allows an element to be treated as an annotation (for JOT), or a Java annotation (for Reflection), or null if the specified annotation does not exist.
 Class getClassForJavaClass(JavaClass javaClass)
           
 ClassLoader getClassLoader()
           
 JavaClass getGenericReturnType(JavaMethod meth)
          Return a given method's generic return type as a JavaClass.
 JavaClass getJavaClass(Class javaClass)
          Return a JavaClass instance created based the provided class.
 JavaClass getJavaClass(String javaClassName)
          Return a JavaClass instance created based on fully qualified class name.
 JavaClass getNextMappedSuperClass(JavaClass jClass)
           
 JavaClass getType(JavaField field)
          Returns a JavaClass instance wrapping the provided field's resolved type.
 HashMap getXMLToJavaTypeMap()
          Return a map of default Java types to XML types.
 boolean isAnnotationPresent(JavaHasAnnotations element, Class annotationClass)
          Indicates if element contains a given annotation.
 boolean isBuiltInJavaType(JavaClass jClass)
          Indicates if the javaType map contains a key equal to the provided JavaClass' raw name.
 void setClassLoader(ClassLoader loader)
           
 void setJavaModel(JavaModel model)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

APBYTE

public static final String APBYTE
See Also:
Constant Field Values

BIGDECIMAL

public static final String BIGDECIMAL
See Also:
Constant Field Values

BIGINTEGER

public static final String BIGINTEGER
See Also:
Constant Field Values

PBOOLEAN

public static final String PBOOLEAN
See Also:
Constant Field Values

PBYTE

public static final String PBYTE
See Also:
Constant Field Values

CALENDAR

public static final String CALENDAR
See Also:
Constant Field Values

PDOUBLE

public static final String PDOUBLE
See Also:
Constant Field Values

PFLOAT

public static final String PFLOAT
See Also:
Constant Field Values

PINT

public static final String PINT
See Also:
Constant Field Values

PLONG

public static final String PLONG
See Also:
Constant Field Values

PSHORT

public static final String PSHORT
See Also:
Constant Field Values

QNAME_CLASS

public static final String QNAME_CLASS
See Also:
Constant Field Values

STRING

public static final String STRING
See Also:
Constant Field Values

ABYTE

public static final String ABYTE
See Also:
Constant Field Values

BOOLEAN

public static final String BOOLEAN
See Also:
Constant Field Values

BYTE

public static final String BYTE
See Also:
Constant Field Values

GREGORIAN_CALENDAR

public static final String GREGORIAN_CALENDAR
See Also:
Constant Field Values

DOUBLE

public static final String DOUBLE
See Also:
Constant Field Values

FLOAT

public static final String FLOAT
See Also:
Constant Field Values

INTEGER

public static final String INTEGER
See Also:
Constant Field Values

UUID

public static final String UUID
See Also:
Constant Field Values

LONG

public static final String LONG
See Also:
Constant Field Values

SHORT

public static final String SHORT
See Also:
Constant Field Values

UTIL_DATE

public static final String UTIL_DATE
See Also:
Constant Field Values

SQL_DATE

public static final String SQL_DATE
See Also:
Constant Field Values

SQL_TIME

public static final String SQL_TIME
See Also:
Constant Field Values

SQL_TIMESTAMP

public static final String SQL_TIMESTAMP
See Also:
Constant Field Values

DURATION

public static final String DURATION
See Also:
Constant Field Values

XMLGREGORIANCALENDAR

public static final String XMLGREGORIANCALENDAR
See Also:
Constant Field Values

URI

public static final String URI
See Also:
Constant Field Values
Constructor Detail

Helper

public Helper(JavaModel model)
INTERNAL: This is the preferred constructor. This constructor builds the map of XML-Java type pairs, and sets the JavaModel and ClassLoader.

Parameters:
model -
Method Detail

getGenericReturnType

public JavaClass getGenericReturnType(JavaMethod meth)
Return a given method's generic return type as a JavaClass.

Parameters:
meth -
Returns:

getJavaClass

public JavaClass getJavaClass(Class javaClass)
Return a JavaClass instance created based the provided class. This assumes that the provided class exists on the classpath - null is returned otherwise.

Parameters:
javaClass -
Returns:

getJavaClass

public JavaClass getJavaClass(String javaClassName)
Return a JavaClass instance created based on fully qualified class name. This assumes that a class with the provided name exists on the classpath - null is returned otherwise.

Parameters:
javaClassName -
Returns:

getXMLToJavaTypeMap

public HashMap getXMLToJavaTypeMap()
Return a map of default Java types to XML types.

Returns:

getAnnotation

public Annotation getAnnotation(JavaHasAnnotations element,
                                Class annotationClass)
Returns a either a dynamic proxy instance that allows an element to be treated as an annotation (for JOT), or a Java annotation (for Reflection), or null if the specified annotation does not exist. Intended to be used in conjunction with isAnnotationPresent.

Parameters:
element -
annotationClass -
Returns:
See Also:
isAnnotationPresent

getType

public JavaClass getType(JavaField field)
Returns a JavaClass instance wrapping the provided field's resolved type.

Parameters:
field -
Returns:

isAnnotationPresent

public boolean isAnnotationPresent(JavaHasAnnotations element,
                                   Class annotationClass)
Indicates if element contains a given annotation.

Parameters:
element -
annotationClass -
Returns:

isBuiltInJavaType

public boolean isBuiltInJavaType(JavaClass jClass)
Indicates if the javaType map contains a key equal to the provided JavaClass' raw name.

Parameters:
jClass -
Returns:

setClassLoader

public void setClassLoader(ClassLoader loader)

setJavaModel

public void setJavaModel(JavaModel model)

getClassLoader

public ClassLoader getClassLoader()

getNextMappedSuperClass

public JavaClass getNextMappedSuperClass(JavaClass jClass)

getClassForJavaClass

public Class getClassForJavaClass(JavaClass javaClass)