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

Class MetadataAnnotation

java.lang.Object

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

public class MetadataAnnotation
extends java.lang.Object

Metadata representation of an annotation.

Since:

EclipseLink 1.2

Author:

James Sutherland

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isMeta Metadata annotation flag
protected java.util.Map<java.lang.String,java.lang.Object>	m_attributes Map of attribute names and values.
protected java.lang.String	m_name The name of the annotation.

Constructor Summary

Constructors

Constructor and Description
MetadataAnnotation()

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String key, java.lang.Object value) INTERNAL:
MetadataAnnotation	getAttributeAnnotation(java.lang.String name) INTERNAL: Return annotation attribute value.
java.lang.Object[]	getAttributeArray(java.lang.String name) INTERNAL: Return the attribute value, or an empty array if not set.
java.lang.Boolean	getAttributeBoolean(java.lang.String name, java.lang.Boolean defaultValue) INTERNAL: Return the boolean attribute value, or the default value if not set.
java.lang.Boolean	getAttributeBooleanDefaultFalse(java.lang.String name) INTERNAL: Return the boolean attribute value, or FALSE if not set.
java.lang.Boolean	getAttributeBooleanDefaultTrue(java.lang.String name) INTERNAL: Return the boolean attribute value, or TRUE if not set.
java.lang.String	getAttributeClass(java.lang.String name, java.lang.Class defaultClass) INTERNAL: Return the Class attribute value, or the default provided.
java.lang.Integer	getAttributeInteger(java.lang.String name) INTERNAL: Return Integer attribute value.
java.util.Map<java.lang.String,java.lang.Object>	getAttributes() INTERNAL:
java.lang.String	getAttributeString(java.lang.String name) INTERNAL: Return the attribute value, or null if not set.
java.lang.String	getAttributeString(java.lang.String name, java.lang.String defaultValue) INTERNAL: Return the attribute value, or defaultValue if not set.
java.lang.String	getName() INTERNAL:
boolean	hasAttribute(java.lang.String name) INTERNAL: Return true if the attribute exists.
boolean	isMeta() INTERNAL:
void	setAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes) INTERNAL:
void	setIsMeta(boolean isMeta) INTERNAL:
void	setName(java.lang.String name) INTERNAL:
java.lang.String	toString() INTERNAL:

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_name

protected java.lang.String m_name

The name of the annotation.

isMeta

protected boolean isMeta

Metadata annotation flag

m_attributes

protected java.util.Map<java.lang.String,java.lang.Object> m_attributes

Map of attribute names and values.

Constructor Detail

MetadataAnnotation

public MetadataAnnotation()

Method Detail

addAttribute

public void addAttribute(java.lang.String key,
                         java.lang.Object value)

INTERNAL:

getAttributeAnnotation

public MetadataAnnotation getAttributeAnnotation(java.lang.String name)

INTERNAL: Return annotation attribute value. You should call this method only if you know the object returned will be a MetadataAnnotation.

getAttributeArray

public java.lang.Object[] getAttributeArray(java.lang.String name)

INTERNAL: Return the attribute value, or an empty array if not set. Callers will have the cast the type.

getAttributeBoolean

public java.lang.Boolean getAttributeBoolean(java.lang.String name,
                                             java.lang.Boolean defaultValue)

INTERNAL: Return the boolean attribute value, or the default value if not set.

getAttributeBooleanDefaultFalse

public java.lang.Boolean getAttributeBooleanDefaultFalse(java.lang.String name)

INTERNAL: Return the boolean attribute value, or FALSE if not set.

getAttributeBooleanDefaultTrue

public java.lang.Boolean getAttributeBooleanDefaultTrue(java.lang.String name)

INTERNAL: Return the boolean attribute value, or TRUE if not set.

getAttributeClass

public java.lang.String getAttributeClass(java.lang.String name,
                                          java.lang.Class defaultClass)

INTERNAL: Return the Class attribute value, or the default provided.

getAttributeInteger

public java.lang.Integer getAttributeInteger(java.lang.String name)

INTERNAL: Return Integer attribute value. You should call this method only if you know the object returned will be an Integer.

getAttributes

public java.util.Map<java.lang.String,java.lang.Object> getAttributes()

INTERNAL:

getAttributeString

public java.lang.String getAttributeString(java.lang.String name)

INTERNAL: Return the attribute value, or null if not set.

getAttributeString

public java.lang.String getAttributeString(java.lang.String name,
                                           java.lang.String defaultValue)

INTERNAL: Return the attribute value, or defaultValue if not set.

getName

public java.lang.String getName()

INTERNAL:

hasAttribute

public boolean hasAttribute(java.lang.String name)

INTERNAL: Return true if the attribute exists.

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)

INTERNAL:

setName

public void setName(java.lang.String name)

INTERNAL:

setIsMeta

public void setIsMeta(boolean isMeta)

INTERNAL:

isMeta

public boolean isMeta()

INTERNAL:

Returns:

true if this annotation is a meta-annotation

toString

public java.lang.String toString()

INTERNAL:

Overrides:

toString in class java.lang.Object