Top Description Fields Constructors Methods
org.eclipse.persistence.internal.jpa.metadata.accessors.objects

public Class MetadataClass

extends MetadataAnnotatedElement
Class Inheritance
Imports
java.io.Serializable, java.util.ArrayList, .Arrays, .Collection, .HashMap, .List, .Locale, .Map, .Set, org.eclipse.persistence.asm.Opcodes, org.eclipse.persistence.internal.helper.Helper

INTERNAL: An object to hold onto a valid JPA decorated class.
Author
Guy Pelletier
Since
TopLink 10.1.3/EJB 3.0 Preview

Field Summary

Modifier and TypeField and Description
protected List<MetadataClass>
protected Map<String, MetadataField>
protected List<String>
protected boolean
protected boolean
protected boolean
protected boolean
protected Map<String, MetadataMethod>
protected int
protected MetadataClass
protected String
Inherited from org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotatedElement:
DEFAULT_RAW_CLASSm_primitiveType

Constructor Summary

AccessConstructor and Description
public
MetadataClass(MetadataFactory factory, String name, boolean isLazy)

Create the metadata class with the class name.

public
MetadataClass(MetadataFactory factory, String name)

Create the metadata class with the class name.

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

Create the metadata class based on the class.

Method Summary

Modifier and TypeMethod and Description
public void
addEnclosedClass(MetadataClass enclosedClass)

INTERNAL:

public void
addField(MetadataField field)

INTERNAL:

public void
addInterface(String interfaceName)

INTERNAL:

public void
addMethod(MetadataMethod method)

INTERNAL:

public boolean
extendsClass(Class<?> javaClass)

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

public boolean
extendsClass(String className)

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

public boolean
extendsInterface(Class<?> javaClass)

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

public boolean
extendsInterface(String className)

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

public List<MetadataClass>
getEnclosedClasses()

INTERNAL: Return the list of classes defined within this metadata class.

public MetadataField
getField(String name)

INTERNAL: Return the field with the name.

public MetadataField
getField(String name, boolean checkSuperClass)

INTERNAL: Return the field with the name.

public Map<String, MetadataField>
getFields()

INTERNAL:

public List<String>
getInterfaces()

INTERNAL:

protected MetadataMethod
getMethod(String name)

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

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

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

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

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

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

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

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

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

public MetadataMethod
getMethodForPropertyName(String propertyName)

INTERNAL: Return the method for the given property name.

public Map<String, MetadataMethod>
getMethods()

INTERNAL:

public int
public MetadataClass
getSuperclass()

INTERNAL:

public String
getSuperclassName()

INTERNAL:

public String
getTypeName()

Return the ASM type name.

public boolean
isAccessible()

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

public boolean
isArray()

INTERNAL: Return if this class is an array type.

public boolean
isClass(Class<?> clazz)

Allow comparison to Java classes and Metadata classes.

public boolean
isCollection()

INTERNAL: Return if this is extends Collection.

public boolean
isEnum()

INTERNAL: Return if this is extends Enum.

public boolean
isInterface()

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

public boolean
isJDK()

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

public boolean
isLazy()

INTERNAL:

public boolean
isList()

INTERNAL: Return if this is extends List.

public boolean
isMap()

INTERNAL: Return if this is extends Map.

public boolean
isObject()

INTERNAL: Return if this is Object class.

public boolean
isPrimitive()

INTERNAL: Return if this is a primitive.

public boolean
isSerializable()

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

public boolean
isSerializableInterface()

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

public boolean
isSet()

INTERNAL: Return true if this extends Set.

public boolean
isVoid()

INTERNAL: Return if this is the void class.

public void
setIsAccessible(boolean isAccessible)

INTERNAL:

public void
setIsJDK(boolean isJDK)

INTERNAL:

public void
setIsLazy(boolean isLazy)

INTERNAL:

public void
public void
public void
setSuperclass(MetadataClass superclass)

INTERNAL:

public void
setSuperclassName(String superclass)

INTERNAL:

Inherited from org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotatedElement:
addAnnotationaddGenericTypeaddMetaAnnotationareAnnotationsCompatibleWithTransientequalsgetAnnotationgetAnnotationgetAnnotationgetAnnotationgetAnnotationsgetAttributeNamegetDeclaredAnnotationsCountgetGenericTypegetMapKeyClassgetNamegetPrimitiveTypegetRawClassgetRawClassWithGenericsgetReferenceClassFromGenericgetTypehasDeclaredAnnotationshashCodeisAnnotationNotPresentisAnnotationNotPresentisAnnotationPresentisAnnotationPresentisAnnotationPresentisArrayisBasicisBasicCollectionisBasicMapisDerivedIdisDerivedIdClassisElementCollectionisEmbeddedisEmbeddedIdisGenericCollectionTypeisGenericTypeisIdisManyToManyisManyToOneisOneToManyisOneToOneisStructureisSupportedCollectionClassisSupportedMapClassisSupportedToManyCollectionClassisTransformationisValidPersistenceElementisValidPersistenceElementisVariableOneToOneisVersionsetAnnotationssetAttributeNamesetGenericTypesetPrimitiveTypesetTypetoString

Field Detail

m_enclosedClassesback to summary
protected List<MetadataClass> m_enclosedClasses
m_fieldsback to summary
protected Map<String, MetadataField> m_fields
m_interfacesback to summary
protected List<String> m_interfaces
m_isAccessibleback to summary
protected boolean m_isAccessible
m_isJDKback to summary
protected boolean m_isJDK
m_isLazyback to summary
protected boolean m_isLazy
m_isPrimitiveback to summary
protected boolean m_isPrimitive
m_methodsback to summary
protected Map<String, MetadataMethod> m_methods
m_modifiersback to summary
protected int m_modifiers

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

m_superclassback to summary
protected MetadataClass m_superclass
m_superclassNameback to summary
protected String m_superclassName

Constructor Detail

MetadataClassback to summary
public MetadataClass(MetadataFactory factory, String name, boolean isLazy)

Create the metadata class with the class name.

MetadataClassback to summary
public MetadataClass(MetadataFactory factory, String name)

Create the metadata class with the class name.

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

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

Method Detail

addEnclosedClassback to summary
public void addEnclosedClass(MetadataClass enclosedClass)

INTERNAL:

addFieldback to summary
public void addField(MetadataField field)

INTERNAL:

addInterfaceback to summary
public void addInterface(String interfaceName)

INTERNAL:

addMethodback to summary
public void addMethod(MetadataMethod method)

INTERNAL:

extendsClassback to summary
public boolean extendsClass(Class<?> javaClass)

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

extendsClassback to summary
public boolean extendsClass(String className)

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

extendsInterfaceback to summary
public boolean extendsInterface(Class<?> javaClass)

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

extendsInterfaceback to summary
public boolean extendsInterface(String className)

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

getEnclosedClassesback to summary
public List<MetadataClass> getEnclosedClasses()

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

getFieldback to summary
public MetadataField getField(String name)

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

getFieldback to summary
public MetadataField getField(String name, boolean checkSuperClass)

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

getFieldsback to summary
public Map<String, MetadataField> getFields()

INTERNAL:

getInterfacesback to summary
public List<String> getInterfaces()

INTERNAL:

getMethodback to summary
protected MetadataMethod getMethod(String name)

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

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

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

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

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

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

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

getMethodback to summary
public MetadataMethod getMethod(String name, String[] arguments)

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

getMethodForPropertyNameback to summary
public MetadataMethod getMethodForPropertyName(String propertyName)

INTERNAL: Return the method for the given property name.

getMethodsback to summary
public Map<String, MetadataMethod> getMethods()

INTERNAL:

getModifiersback to summary
public int getModifiers()

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

INTERNAL:

Annotations
@Override
getSuperclassback to summary
public MetadataClass getSuperclass()

INTERNAL:

getSuperclassNameback to summary
public String getSuperclassName()

INTERNAL:

getTypeNameback to summary
public String getTypeName()

Return the ASM type name.

isAccessibleback to summary
public boolean isAccessible()

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

isArrayback to summary
public boolean isArray()

INTERNAL: Return if this class is an array type.

isClassback to summary
public boolean isClass(Class<?> clazz)

Allow comparison to Java classes and Metadata classes.

isCollectionback to summary
public boolean isCollection()

INTERNAL: Return if this is extends Collection.

isEnumback to summary
public boolean isEnum()

INTERNAL: Return if this is extends Enum.

isInterfaceback to summary
public boolean isInterface()

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

isJDKback to summary
public boolean isJDK()

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

isLazyback to summary
public boolean isLazy()

INTERNAL:

isListback to summary
public boolean isList()

INTERNAL: Return if this is extends List.

isMapback to summary
public boolean isMap()

INTERNAL: Return if this is extends Map.

isObjectback to summary
public boolean isObject()

INTERNAL: Return if this is Object class.

isPrimitiveback to summary
public boolean isPrimitive()

INTERNAL: Return if this is a primitive.

isSerializableback to summary
public boolean isSerializable()

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

isSerializableInterfaceback to summary
public boolean isSerializableInterface()

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

isSetback to summary
public boolean isSet()

INTERNAL: Return true if this extends Set.

isVoidback to summary
public boolean isVoid()

INTERNAL: Return if this is the void class.

setIsAccessibleback to summary
public void setIsAccessible(boolean isAccessible)

INTERNAL:

setIsJDKback to summary
public void setIsJDK(boolean isJDK)

INTERNAL:

setIsLazyback to summary
public void setIsLazy(boolean isLazy)

INTERNAL:

setModifiersback to summary
public void setModifiers(int modifiers)

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

INTERNAL:

Annotations
@Override
setNameback to summary
public void setName(String name)

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

INTERNAL:

Annotations
@Override
setSuperclassback to summary
public void setSuperclass(MetadataClass superclass)

INTERNAL:

setSuperclassNameback to summary
public void setSuperclassName(String superclass)

INTERNAL: