MetadataAnnotatedElement

java.lang.Object
- org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject
- - org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotatedElement

Direct Known Subclasses:

MetadataClass, MetadataField, MetadataMethod
```
public class MetadataAnnotatedElement
extends MetadataAccessibleObject
```
INTERNAL: Parent object that is used to hold onto a valid JPA decorated method, field or class.

Since:

EclipseLink 1.0

Author:

Guy Pelletier

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String DEFAULT_RAW_CLASS
- Fields inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject
  m_factory

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_RAW_CLASS`

Constructor Summary

Constructors
Constructor and Description

MetadataAnnotatedElement(MetadataFactory factory)
INTERNAL:

Constructors
Constructor and Description
`MetadataAnnotatedElement(MetadataFactory factory)` INTERNAL:

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAnnotation(MetadataAnnotation annotation)` INTERNAL:
`void`	`addGenericType(java.lang.String genericType)` INTERNAL:
`void`	`addMetaAnnotation(MetadataAnnotation annotation)` INTERNAL:
`boolean`	`areAnnotationsCompatibleWithTransient(ClassAccessor classAccessor)` INTERNAL: Return true if this accessible object has 2 or more declared persistence annotations.
`boolean`	`equals(java.lang.Object object)` INTERNAL:
`MetadataAnnotation`	`getAnnotation(java.lang.Class annotation)` INTERNAL: Return the annotated element for this accessor.
`MetadataAnnotation`	`getAnnotation(java.lang.String annotation)` INTERNAL: Return the annotated element for this accessor.
`MetadataAnnotation`	`getAnnotation(java.lang.String annotationClassName, ClassAccessor classAccessor)` INTERNAL: Return the annotated element for this accessor.
`protected MetadataAnnotation`	`getAnnotation(java.lang.String annotation, java.util.Set<java.lang.String> names)` INTERNAL: Return the annotated element for this accessor.
`java.util.Map<java.lang.String,MetadataAnnotation>`	`getAnnotations()` INTERNAL: Return the annotations of this accessible object.
`java.lang.String`	`getAttributeName()` INTERNAL:
`protected int`	`getDeclaredAnnotationsCount(ClassAccessor classAccessor)` INTERNAL:
`java.util.List<java.lang.String>`	`getGenericType()` INTERNAL:
`MetadataClass`	`getMapKeyClass(MetadataDescriptor descriptor)` INTERNAL: This should only be called for accessor's of type Map.
`int`	`getModifiers()` INTERNAL:
`java.lang.String`	`getName()` INTERNAL:
`java.lang.Object`	`getPrimitiveType()` INTERNAL: If this annotated element was built from java model elements and is a primitive type, this primitive type will be set.
`MetadataClass`	`getRawClass(MetadataDescriptor descriptor)` INTERNAL: Return the raw class for this accessible object.
`MetadataClass`	`getRawClassWithGenerics(MetadataDescriptor descriptor)` INTERNAL: Return the complete raw class with generics for this accessible object.
`MetadataClass`	`getReferenceClassFromGeneric(MetadataDescriptor descriptor)` INTERNAL: Return the reference class from the generic specification on this accessible object.
`java.lang.String`	`getType()` INTERNAL:
`boolean`	`hasDeclaredAnnotations(ClassAccessor classAccessor)` INTERNAL: Return true if this accessible object has 1 or more declared persistence annotations.
`int`	`hashCode()` INTERNAL:
`boolean`	`isAnnotationNotPresent(java.lang.Class annotation, ClassAccessor accessor)` INTERNAL: Indicates whether the specified annotation is actually not present on this accessible object.
`boolean`	`isAnnotationNotPresent(java.lang.String annotation, ClassAccessor accessor)` INTERNAL: Indicates whether the specified annotation is actually not present on this accessible object.
`boolean`	`isAnnotationPresent(java.lang.Class annotationClass, ClassAccessor accessor)` INTERNAL: Indicates whether the specified annotation is present on java class for the given descriptor metadata.
`boolean`	`isAnnotationPresent(java.lang.String annotation)` INTERNAL: Indicates whether the specified annotation is present on this accessible object.
`boolean`	`isAnnotationPresent(java.lang.String annotationName, ClassAccessor accessor)` INTERNAL: Indicates whether the specified annotation is present on java class for the given descriptor metadata.
`boolean`	`isArray(ClassAccessor classAccessor)` INTERNAL: Return true if this field accessor represents an array relationship.
`boolean`	`isBasic(ClassAccessor classAccessor)` INTERNAL: Return true if this accessor represents a basic mapping.
`boolean`	`isBasicCollection(ClassAccessor classAccessor)` INTERNAL: Return true if this accessor represents a basic collection mapping.
`boolean`	`isBasicMap(ClassAccessor classAccessor)` INTERNAL: Return true if this accessor represents a basic collection mapping.
`boolean`	`isDerivedId(ClassAccessor classAccessor)` INTERNAL: Return true if this accessor represents an id mapping.
`boolean`	`isDerivedIdClass(ClassAccessor classAccessor)` INTERNAL: Return true if this accessor represents an id mapping.
`boolean`	`isElementCollection(ClassAccessor classAccessor)` INTERNAL: Return true if this accessor represents an element collection mapping.
`boolean`	`isEmbedded(ClassAccessor classAccessor)` INTERNAL: Return true if this accessor represents an aggregate mapping.
`boolean`	`isEmbeddedId(ClassAccessor classAccessor)` INTERNAL: Return true if this accessor represents an aggregate id mapping.
`boolean`	`isGenericCollectionType()` INTERNAL: Method to return whether a collection type is a generic.
`boolean`	`isGenericType()` INTERNAL: Method to return whether a type is a generic.
`boolean`	`isId(ClassAccessor classAccessor)` INTERNAL: Return true if this accessor represents an id mapping.
`boolean`	`isManyToMany(ClassAccessor classAccessor)` INTERNAL: Return true if this field accessor represents a m-m relationship.
`boolean`	`isManyToOne(ClassAccessor classAccessor)` INTERNAL: Return true if this accessor represents a m-1 relationship.
`boolean`	`isOneToMany(ClassAccessor classAccessor)` INTERNAL: Return true if this accessor represents a 1-m relationship.
`boolean`	`isOneToOne(ClassAccessor classAccessor)` INTERNAL: Return true if this accessor represents a 1-1 relationship.
`boolean`	`isStructure(ClassAccessor classAccessor)` INTERNAL: Return true if this field accessor represents a structure relationship.
`boolean`	`isSupportedCollectionClass(MetadataClass metadataClass)` INTERNAL: Method to return whether the given class is a supported collection class.
`boolean`	`isSupportedMapClass(MetadataClass metadataClass)` INTERNAL: Method to return whether the given class is a supported map class.
`boolean`	`isSupportedToManyCollectionClass(MetadataClass metadataClass)` INTERNAL: Method to return whether the given class is a supported to many collection class.
`boolean`	`isTransformation(ClassAccessor classAccessor)` INTERNAL: Return true if this accessor represents an transformation mapping.
`protected boolean`	`isValidPersistenceElement(boolean mustBeExplicit, java.lang.String explicitType, ClassAccessor classAccessor)` INTERNAL: When processing the inverse accessors to an explicit access setting, their must be an Access(FIELD) or Access(PROPERTY) present for the element to be processed.
`protected boolean`	`isValidPersistenceElement(int modifiers)` INTERNAL: Return true if the modifiers are not transient, static or abstract.
`boolean`	`isVariableOneToOne(ClassAccessor classAccessor)` INTERNAL: Return true if this accessor represents a variable 1-1 relationship.
`boolean`	`isVersion(ClassAccessor classAccessor)` INTERNAL: Return true if this accessor represents a version mapping.
`void`	`setAnnotations(java.util.Map<java.lang.String,MetadataAnnotation> annotations)` INTERNAL: Set the annotations of this accessible object.
`void`	`setAttributeName(java.lang.String attributeName)` INTERNAL:
`void`	`setGenericType(java.util.List<java.lang.String> genericType)` INTERNAL:
`void`	`setModifiers(int modifiers)` INTERNAL:
`void`	`setName(java.lang.String name)` INTERNAL:
`void`	`setPrimitiveType(java.lang.Object primitiveType)` INTERNAL: If this annotated element was built from java model elements and is a primitive type this method will be called.
`void`	`setType(java.lang.String type)` INTERNAL:
`java.lang.String`	`toString()` INTERNAL:

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 Detail
  - DEFAULT_RAW_CLASS
```
public static final java.lang.String DEFAULT_RAW_CLASS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MetadataAnnotatedElement
```
public MetadataAnnotatedElement(MetadataFactory factory)
```
    INTERNAL:
- Method Detail
  - addAnnotation
```
public void addAnnotation(MetadataAnnotation annotation)
```
    INTERNAL:
  - addMetaAnnotation
```
public void addMetaAnnotation(MetadataAnnotation annotation)
```
    INTERNAL:
  - addGenericType
```
public void addGenericType(java.lang.String genericType)
```
    INTERNAL:
  - equals
```
public boolean equals(java.lang.Object object)
```
    INTERNAL:
    
    Overrides:
    
    equals in class java.lang.Object
  - getAnnotation
```
public MetadataAnnotation getAnnotation(java.lang.Class annotation)
```
    INTERNAL: Return the annotated element for this accessor. Note: This method does not check against a metadata complete.
  - getAnnotation
```
public MetadataAnnotation getAnnotation(java.lang.String annotation)
```
    INTERNAL: Return the annotated element for this accessor. Note: This method does not check against a meta-data complete.
    
    Parameters:
    
    annotation - annotation name
  - getAnnotation
```
protected final MetadataAnnotation getAnnotation(java.lang.String annotation,
                                                 java.util.Set<java.lang.String> names)
```
    INTERNAL: Return the annotated element for this accessor. Note: This method does not check against a meta-data complete.
    
    Parameters:
    
    annotation - annotation name
    
    names - meta-annotations names cycle detection set, shall not be null
  - getAnnotation
```
public MetadataAnnotation getAnnotation(java.lang.String annotationClassName,
                                        ClassAccessor classAccessor)
```
    INTERNAL: Return the annotated element for this accessor.
  - getAnnotations
```
public java.util.Map<java.lang.String,MetadataAnnotation> getAnnotations()
```
    INTERNAL: Return the annotations of this accessible object.
    
    Returns:
    
    annotations defined for the element, keyed by annotation name. Never returns null.
  - getAttributeName
```
public java.lang.String getAttributeName()
```
    INTERNAL:
    
    Specified by:
    
    getAttributeName in class MetadataAccessibleObject
  - getDeclaredAnnotationsCount
```
protected int getDeclaredAnnotationsCount(ClassAccessor classAccessor)
```
    INTERNAL:
  - getGenericType
```
public java.util.List<java.lang.String> getGenericType()
```
    INTERNAL:
  - getMapKeyClass
```
public MetadataClass getMapKeyClass(MetadataDescriptor descriptor)
```
    INTERNAL: This should only be called for accessor's of type Map. It will return the map key type if generics are used, null otherwise.
  - getModifiers
```
public int getModifiers()
```
    INTERNAL:
  - getName
```
public java.lang.String getName()
```
    INTERNAL:
    
    Specified by:
    
    getName in class MetadataAccessibleObject
  - getPrimitiveType
```
public java.lang.Object getPrimitiveType()
```
    INTERNAL: If this annotated element was built from java model elements and is a primitive type, this primitive type will be set.
  - getRawClass
```
public MetadataClass getRawClass(MetadataDescriptor descriptor)
```
    INTERNAL: Return the raw class for this accessible object. E.g. For an accessible object with a type of java.util.Collection<Employee>, this method will return java.util.Collection.
    
    See Also:
    
    to get Employee.class back., to get java.util.CollectionEmployee back.
  - getRawClassWithGenerics
```
public MetadataClass getRawClassWithGenerics(MetadataDescriptor descriptor)
```
    INTERNAL: Return the complete raw class with generics for this accessible object. E.g. For an accessible object with a type of java.util.Collection<Employee>, this method will return java.util.CollectionEmployee. Note, the generics are appended to the name of the class.
    
    See Also:
    
    to get Employee.class back., to get java.util.Collection back.
  - getReferenceClassFromGeneric
```
public MetadataClass getReferenceClassFromGeneric(MetadataDescriptor descriptor)
```
    INTERNAL: Return the reference class from the generic specification on this accessible object. Here is what you will get back from this method given the following scenarios: 1 - public Collection<String> getTasks() => String.class 2 - public Map<String, Integer> getTasks() => Integer.class 3 - public Employee getEmployee() => null 4 - public Collection getTasks() => null 5 - public Map getTasks() => null 6 - public Collection<byte[]> getAudio() => byte[].class 7 - public Map<X,Y> on a MappedSuperclass where Y is defined in the Entity superclass<T> => Void.class (in all bug 266912 cases)
  - getType
```
public java.lang.String getType()
```
    INTERNAL:
  - hasDeclaredAnnotations
```
public boolean hasDeclaredAnnotations(ClassAccessor classAccessor)
```
    INTERNAL: Return true if this accessible object has 1 or more declared persistence annotations.
  - hashCode
```
public int hashCode()
```
    INTERNAL:
    
    Overrides:
    
    hashCode in class java.lang.Object
  - areAnnotationsCompatibleWithTransient
```
public boolean areAnnotationsCompatibleWithTransient(ClassAccessor classAccessor)
```
    INTERNAL: Return true if this accessible object has 2 or more declared persistence annotations.
  - isAnnotationNotPresent
```
public boolean isAnnotationNotPresent(java.lang.Class annotation,
                                      ClassAccessor accessor)
```
    INTERNAL: Indicates whether the specified annotation is actually not present on this accessible object. Used for defaulting. Need this check since the isAnnotationPresent calls can return a false when true because of the meta-data complete feature.
  - isAnnotationNotPresent
```
public boolean isAnnotationNotPresent(java.lang.String annotation,
                                      ClassAccessor accessor)
```
    INTERNAL: Indicates whether the specified annotation is actually not present on this accessible object. Used for defaulting. Need this check since the isAnnotationPresent calls can return a false when true because of the meta-data complete feature.
  - isAnnotationPresent
```
public boolean isAnnotationPresent(java.lang.Class annotationClass,
                                   ClassAccessor accessor)
```
    INTERNAL: Indicates whether the specified annotation is present on java class for the given descriptor metadata.
  - isAnnotationPresent
```
public boolean isAnnotationPresent(java.lang.String annotation)
```
    INTERNAL: Indicates whether the specified annotation is present on this accessible object. NOTE: Calling this method directly does not take any metadata complete flag into consideration. Look at the other isAnnotationPresent methods that takes a class accessor.
  - isAnnotationPresent
```
public boolean isAnnotationPresent(java.lang.String annotationName,
                                   ClassAccessor accessor)
```
    INTERNAL: Indicates whether the specified annotation is present on java class for the given descriptor metadata.
  - isArray
```
public boolean isArray(ClassAccessor classAccessor)
```
    INTERNAL: Return true if this field accessor represents an array relationship.
  - isBasic
```
public boolean isBasic(ClassAccessor classAccessor)
```
    INTERNAL: Return true if this accessor represents a basic mapping.
  - isBasicCollection
```
public boolean isBasicCollection(ClassAccessor classAccessor)
```
    INTERNAL: Return true if this accessor represents a basic collection mapping.
  - isBasicMap
```
public boolean isBasicMap(ClassAccessor classAccessor)
```
    INTERNAL: Return true if this accessor represents a basic collection mapping.
  - isDerivedId
```
public boolean isDerivedId(ClassAccessor classAccessor)
```
    INTERNAL: Return true if this accessor represents an id mapping.
  - isDerivedIdClass
```
public boolean isDerivedIdClass(ClassAccessor classAccessor)
```
    INTERNAL: Return true if this accessor represents an id mapping.
  - isElementCollection
```
public boolean isElementCollection(ClassAccessor classAccessor)
```
    INTERNAL: Return true if this accessor represents an element collection mapping.
  - isEmbedded
```
public boolean isEmbedded(ClassAccessor classAccessor)
```
    INTERNAL: Return true if this accessor represents an aggregate mapping. True is returned if an Embedded annotation is found or if an Embeddable annotation is found on the raw/reference class.
  - isEmbeddedId
```
public boolean isEmbeddedId(ClassAccessor classAccessor)
```
    INTERNAL: Return true if this accessor represents an aggregate id mapping.
  - isGenericCollectionType
```
public boolean isGenericCollectionType()
```
    INTERNAL: Method to return whether a collection type is a generic.
  - isGenericType
```
public boolean isGenericType()
```
    INTERNAL: Method to return whether a type is a generic.
  - isId
```
public boolean isId(ClassAccessor classAccessor)
```
    INTERNAL: Return true if this accessor represents an id mapping.
  - isManyToMany
```
public boolean isManyToMany(ClassAccessor classAccessor)
```
    INTERNAL: Return true if this field accessor represents a m-m relationship.
  - isManyToOne
```
public boolean isManyToOne(ClassAccessor classAccessor)
```
    INTERNAL: Return true if this accessor represents a m-1 relationship.
  - isOneToMany
```
public boolean isOneToMany(ClassAccessor classAccessor)
```
    INTERNAL: Return true if this accessor represents a 1-m relationship.
  - isOneToOne
```
public boolean isOneToOne(ClassAccessor classAccessor)
```
    INTERNAL: Return true if this accessor represents a 1-1 relationship.
  - isStructure
```
public boolean isStructure(ClassAccessor classAccessor)
```
    INTERNAL: Return true if this field accessor represents a structure relationship.
  - isSupportedCollectionClass
```
public boolean isSupportedCollectionClass(MetadataClass metadataClass)
```
    INTERNAL: Method to return whether the given class is a supported collection class.
  - isSupportedMapClass
```
public boolean isSupportedMapClass(MetadataClass metadataClass)
```
    INTERNAL: Method to return whether the given class is a supported map class.
  - isSupportedToManyCollectionClass
```
public boolean isSupportedToManyCollectionClass(MetadataClass metadataClass)
```
    INTERNAL: Method to return whether the given class is a supported to many collection class.
  - isTransformation
```
public boolean isTransformation(ClassAccessor classAccessor)
```
    INTERNAL: Return true if this accessor represents an transformation mapping.
  - isValidPersistenceElement
```
protected boolean isValidPersistenceElement(boolean mustBeExplicit,
                                            java.lang.String explicitType,
                                            ClassAccessor classAccessor)
```
    INTERNAL: When processing the inverse accessors to an explicit access setting, their must be an Access(FIELD) or Access(PROPERTY) present for the element to be processed. Otherwise, it is ignored.
  - isValidPersistenceElement
```
protected boolean isValidPersistenceElement(int modifiers)
```
    INTERNAL: Return true if the modifiers are not transient, static or abstract.
  - isVariableOneToOne
```
public boolean isVariableOneToOne(ClassAccessor classAccessor)
```
    INTERNAL: Return true if this accessor represents a variable 1-1 relationship. The method will return true if one of the following conditions is met: - There is a VariableOneToOne annotation present, or - The raw class is an interface and not a collection or map, nor a ValueHolderInterface (and an exclude default mappings flag is not set)
  - isVersion
```
public boolean isVersion(ClassAccessor classAccessor)
```
    INTERNAL: Return true if this accessor represents a version mapping.
  - setAnnotations
```
public void setAnnotations(java.util.Map<java.lang.String,MetadataAnnotation> annotations)
```
    INTERNAL: Set the annotations of this accessible object.
  - setAttributeName
```
public void setAttributeName(java.lang.String attributeName)
```
    INTERNAL:
  - setGenericType
```
public void setGenericType(java.util.List<java.lang.String> genericType)
```
    INTERNAL:
  - setModifiers
```
public void setModifiers(int modifiers)
```
    INTERNAL:
  - setName
```
public void setName(java.lang.String name)
```
    INTERNAL:
  - setPrimitiveType
```
public void setPrimitiveType(java.lang.Object primitiveType)
```
    INTERNAL: If this annotated element was built from java model elements and is a primitive type this method will be called.
  - setType
```
public void setType(java.lang.String type)
```
    INTERNAL:
  - toString
```
public java.lang.String toString()
```
    INTERNAL:
    
    Overrides:
    
    toString in class java.lang.Object

Class MetadataAnnotatedElement

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_RAW_CLASS

Constructor Detail

MetadataAnnotatedElement

Method Detail

addAnnotation

addMetaAnnotation

addGenericType

equals

getAnnotation

getAnnotation

getAnnotation

getAnnotation

getAnnotations

getAttributeName

getDeclaredAnnotationsCount

getGenericType

getMapKeyClass

getModifiers

getName

getPrimitiveType

getRawClass

getRawClassWithGenerics

getReferenceClassFromGeneric

getType

hasDeclaredAnnotations

hashCode

areAnnotationsCompatibleWithTransient

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

setModifiers

setName

setPrimitiveType

setType

toString