Module org.eclipse.persistence.jpa

Package org.eclipse.persistence.internal.jpa.metadata.accessors.objects

Class MetadataClass

java.lang.Object

org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject

org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotatedElement

org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataClass

public class MetadataClass
extends MetadataAnnotatedElement

INTERNAL: An object to hold onto a valid JPA decorated class.

Since:

TopLink 10.1.3/EJB 3.0 Preview

Field Summary

Fields

Modifier and Type	Field	Description
protected List<MetadataClass>	m_enclosedClasses
protected Map<String,MetadataField>	m_fields
protected List<String>	m_interfaces
protected boolean	m_isAccessible
protected boolean	m_isJDK
protected boolean	m_isLazy
protected boolean	m_isPrimitive
protected Map<String,MetadataMethod>	m_methods
protected int	m_modifiers
protected MetadataClass	m_superclass
protected String	m_superclassName

Fields inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotatedElement

DEFAULT_RAW_CLASS

Fields inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject

m_factory

Constructor Summary

Constructors

Constructor	Description
MetadataClass(MetadataFactory factory, Class<?> cls)	Create the metadata class based on the class.
MetadataClass(MetadataFactory factory, String name)	Create the metadata class with the class name.
MetadataClass(MetadataFactory factory, String name, boolean isLazy)	Create the metadata class with the class name.

Method Summary

Modifier and Type	Method	Description
void	addEnclosedClass(MetadataClass enclosedClass)	INTERNAL:
void	addField(MetadataField field)	INTERNAL:
void	addInterface(String interfaceName)	INTERNAL:
void	addMethod(MetadataMethod method)	INTERNAL:
boolean	extendsClass(Class<?> javaClass)	INTERNAL: Return if this class is or extends, or super class extends the class.
boolean	extendsClass(String className)	INTERNAL: Return if this class is or extends, or super class extends the class.
boolean	extendsInterface(Class<?> javaClass)	INTERNAL: Return if this class is or extends, or super class extends the interface.
boolean	extendsInterface(String className)	INTERNAL: Return if this class is or extends, or super class extends the interface.
List<MetadataClass>	getEnclosedClasses()	INTERNAL: Return the list of classes defined within this metadata class.
MetadataField	getField(String name)	INTERNAL: Return the field with the name.
MetadataField	getField(String name, boolean checkSuperClass)	INTERNAL: Return the field with the name.
Map<String,MetadataField>	getFields()	INTERNAL:
List<String>	getInterfaces()	INTERNAL:
protected MetadataMethod	getMethod(String name)	INTERNAL: Return the method with the name and no arguments.
MetadataMethod	getMethod(String name, Class<?>[] arguments)	INTERNAL: Return the method with the name and argument types.
MetadataMethod	getMethod(String name, String[] arguments)	INTERNAL: Return the method with the name and argument types (class names).
MetadataMethod	getMethod(String name, List<String> arguments)	INTERNAL: Return the method with the name and argument types (class names).
MetadataMethod	getMethod(String name, List<String> arguments, boolean checkSuperClass)	INTERNAL: Return the method with the name and argument types (class names).
MetadataMethod	getMethodForPropertyName(String propertyName)	INTERNAL: Return the method for the given property name.
Map<String,MetadataMethod>	getMethods()	INTERNAL:
int	getModifiers()	INTERNAL:
MetadataClass	getSuperclass()	INTERNAL:
String	getSuperclassName()	INTERNAL:
String	getTypeName()	Return the ASM type name.
boolean	isAccessible()	INTERNAL: Return true is this class accessible to be found.
boolean	isArray()	INTERNAL: Return if this class is an array type.
boolean	isClass(Class<?> clazz)	Allow comparison to Java classes and Metadata classes.
boolean	isCollection()	INTERNAL: Return if this is extends Collection.
boolean	isEnum()	INTERNAL: Return if this is extends Enum.
boolean	isInterface()	INTERNAL: Return if this is an interface (super is null).
boolean	isJDK()	INTERNAL: Return if this is a JDK (java/javax) class.
boolean	isLazy()	INTERNAL:
boolean	isList()	INTERNAL: Return if this is extends List.
boolean	isMap()	INTERNAL: Return if this is extends Map.
boolean	isObject()	INTERNAL: Return if this is Object class.
boolean	isPrimitive()	INTERNAL: Return if this is a primitive.
boolean	isSerializable()	INTERNAL: Return if this class extends Serializable or is an array type.
boolean	isSerializableInterface()	INTENAL: Return true is this class is the Serializable.class interface.
boolean	isSet()	INTERNAL: Return true if this extends Set.
boolean	isVoid()	INTERNAL: Return if this is the void class.
void	setIsAccessible(boolean isAccessible)	INTERNAL:
void	setIsJDK(boolean isJDK)	INTERNAL:
void	setIsLazy(boolean isLazy)	INTERNAL:
void	setModifiers(int modifiers)	INTERNAL:
void	setName(String name)	INTERNAL:
void	setSuperclass(MetadataClass superclass)	INTERNAL:
void	setSuperclassName(String superclass)	INTERNAL:

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotatedElement

addAnnotation, addGenericType, addMetaAnnotation, areAnnotationsCompatibleWithTransient, equals, getAnnotation, getAnnotation, getAnnotation, getAnnotation, getAnnotations, getAttributeName, getDeclaredAnnotationsCount, getGenericType, getMapKeyClass, getName, getPrimitiveType, getRawClass, getRawClassWithGenerics, getReferenceClassFromGeneric, getType, hasDeclaredAnnotations, hashCode, isAnnotationNotPresent, isAnnotationNotPresent, isAnnotationPresent, isAnnotationPresent, isAnnotationPresent, isArray, isBasic, isBasicCollection, isBasicMap, isDerivedId, isDerivedIdClass, isElementCollection, isEmbedded, isEmbeddedId, isGenericCollectionType, isGenericType, isId, isManyToMany, isManyToOne, isOneToMany, isOneToOne, isStructure, isSupportedCollectionClass, isSupportedMapClass, isSupportedToManyCollectionClass, isTransformation, isValidPersistenceElement, isValidPersistenceElement, isVariableOneToOne, isVersion, setAnnotations, setAttributeName, setGenericType, setPrimitiveType, setType, toString

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject

getLogger, getMetadataClass, getMetadataFactory, setMetadataFactory

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

m_isLazy

protected boolean m_isLazy

m_isAccessible

protected boolean m_isAccessible

m_isPrimitive

protected boolean m_isPrimitive

m_isJDK

protected boolean m_isJDK

m_modifiers

protected int m_modifiers

m_interfaces

protected List<String> m_interfaces

m_enclosedClasses

protected List<MetadataClass> m_enclosedClasses

m_fields

protected Map<String,MetadataField> m_fields

m_methods

protected Map<String,MetadataMethod> m_methods

m_superclass

protected MetadataClass m_superclass

m_superclassName

protected String m_superclassName

Constructor Details

MetadataClass

public MetadataClass(MetadataFactory factory,
 String name,
 boolean isLazy)

Create the metadata class with the class name.

MetadataClass

public MetadataClass(MetadataFactory factory,
 String name)

Create the metadata class with the class name.

MetadataClass

public MetadataClass(MetadataFactory factory,
 Class<?> cls)

Create the metadata class based on the class. Mainly used for primitive defaults.

Method Details

addEnclosedClass

public void addEnclosedClass(MetadataClass enclosedClass)

INTERNAL:

addField

public void addField(MetadataField field)

INTERNAL:

addInterface

public void addInterface(String interfaceName)

INTERNAL:

addMethod

public void addMethod(MetadataMethod method)

INTERNAL:

isClass

public boolean isClass(Class<?> clazz)

Allow comparison to Java classes and Metadata classes.

extendsClass

public boolean extendsClass(Class<?> javaClass)

INTERNAL: Return if this class is or extends, or super class extends the class.

extendsClass

public boolean extendsClass(String className)

INTERNAL: Return if this class is or extends, or super class extends the class.

extendsInterface

public boolean extendsInterface(Class<?> javaClass)

INTERNAL: Return if this class is or extends, or super class extends the interface.

extendsInterface

public boolean extendsInterface(String className)

INTERNAL: Return if this class is or extends, or super class extends the interface.

getEnclosedClasses

public List<MetadataClass> getEnclosedClasses()

INTERNAL: Return the list of classes defined within this metadata class. E.g. enums and inner classes.

getField

public MetadataField getField(String name)

INTERNAL: Return the field with the name. Search for any declared or inherited field.

getField

public MetadataField getField(String name,
 boolean checkSuperClass)

INTERNAL: Return the field with the name. Search for any declared or inherited field.

getFields

public Map<String,MetadataField> getFields()

INTERNAL:

getInterfaces

public List<String> getInterfaces()

INTERNAL:

getMethod

protected MetadataMethod getMethod(String name)

INTERNAL: Return the method with the name and no arguments.

getMethod

public MetadataMethod getMethod(String name,
 Class<?>[] arguments)

INTERNAL: Return the method with the name and argument types.

getMethod

public MetadataMethod getMethod(String name,
 List<String> arguments)

INTERNAL: Return the method with the name and argument types (class names).

getMethod

public MetadataMethod getMethod(String name,
 List<String> arguments,
 boolean checkSuperClass)

INTERNAL: Return the method with the name and argument types (class names).

getMethod

public MetadataMethod getMethod(String name,
 String[] arguments)

INTERNAL: Return the method with the name and argument types (class names).

getMethodForPropertyName

public MetadataMethod getMethodForPropertyName(String propertyName)

INTERNAL: Return the method for the given property name.

getMethods

public Map<String,MetadataMethod> getMethods()

INTERNAL:

getModifiers

public int getModifiers()

INTERNAL:

Overrides:

getModifiers in class MetadataAnnotatedElement

getSuperclass

public MetadataClass getSuperclass()

INTERNAL:

getSuperclassName

public String getSuperclassName()

INTERNAL:

getTypeName

public String getTypeName()

Return the ASM type name.

isAccessible

public boolean isAccessible()

INTERNAL: Return true is this class accessible to be found.

isArray

public boolean isArray()

INTERNAL: Return if this class is an array type.

isCollection

public boolean isCollection()

INTERNAL: Return if this is extends Collection.

isEnum

public boolean isEnum()

INTERNAL: Return if this is extends Enum.

isInterface

public boolean isInterface()

INTERNAL: Return if this is an interface (super is null).

isJDK

public boolean isJDK()

INTERNAL: Return if this is a JDK (java/javax) class.

isLazy

public boolean isLazy()

INTERNAL:

isList

public boolean isList()

INTERNAL: Return if this is extends List.

isMap

public boolean isMap()

INTERNAL: Return if this is extends Map.

isObject

public boolean isObject()

INTERNAL: Return if this is Object class.

isPrimitive

public boolean isPrimitive()

INTERNAL: Return if this is a primitive.

isSerializable

public boolean isSerializable()

INTERNAL: Return if this class extends Serializable or is an array type.

isSerializableInterface

public boolean isSerializableInterface()

INTENAL: Return true is this class is the Serializable.class interface.

isSet

public boolean isSet()

INTERNAL: Return true if this extends Set.

isVoid

public boolean isVoid()

INTERNAL: Return if this is the void class.

setIsAccessible

public void setIsAccessible(boolean isAccessible)

INTERNAL:

setIsJDK

public void setIsJDK(boolean isJDK)

INTERNAL:

setIsLazy

public void setIsLazy(boolean isLazy)

INTERNAL:

setModifiers

public void setModifiers(int modifiers)

INTERNAL:

Overrides:

setModifiers in class MetadataAnnotatedElement

setName

public void setName(String name)

INTERNAL:

Overrides:

setName in class MetadataAnnotatedElement

setSuperclass

public void setSuperclass(MetadataClass superclass)

INTERNAL:

setSuperclassName

public void setSuperclassName(String superclass)

INTERNAL: