Oracle Coherence for C++ API
Release 3.7.1.0

E22845-01

AnnotatedElement Class Reference

#include <coherence/lang/AnnotatedElement.hpp>

Inherits Object.

Inherited by Class, and Method.

List of all members.


Detailed Description

AnnotatedElement represents an annotated element.

Author:
mf 2011.03.01
Since:
Coherence 3.7.1
 

Public Types

typedef spec::Handle Handle
 AnnotatedElement Handle definition.
typedef spec::View View
 AnnotatedElement View definition.
typedef spec::Holder Holder
 AnnotatedElement Holder definition.

Public Member Functions

virtual Annotation::View getAnnotation (TypedHandle< const Class > vClassAnnotation) const
 Returns this element's annotation for the specified type if such an annotation is present, else NULL.
virtual ObjectArray::View getAnnotations () const
 Returns all annotations present on this element.
virtual ObjectArray::View getDeclaredAnnotations () const
 Returns all annotations directly present on this element.
virtual bool isAnnotationPresent (TypedHandle< const Class > vClassAnnotation) const
 Return true the specified annotation is present on this element.
virtual
AnnotatedElement::Handle 
addAnnotation (Annotation::View vAnnotation)
 Add the specified Annotation to this element.
virtual
AnnotatedElement::View 
getSuperelement () const
 Return the parent of this AnnotationElement or NULL if there is none.

Protected Member Functions

 AnnotatedElement ()
 Construct an AnnotatedElement.

Protected Attributes

MemberHandle< Objectm_hMapAnnotations
 The map of resolved annotations, key'd by annotation type Class.
MemberHandle< Objectm_hListAnnotationsDeclared
 The list of declared annotations.

Member Function Documentation

virtual Annotation::View getAnnotation ( TypedHandle< const Class vClassAnnotation  )  const [virtual]

Returns this element's annotation for the specified type if such an annotation is present, else NULL.

Parameters:
 vClassAnnotation the annotation type
Returns:
the Annotation or NULL if not present

virtual ObjectArray::View getAnnotations (  )  const [virtual]

Returns all annotations present on this element.

Returns:
all annotations present on this element

virtual ObjectArray::View getDeclaredAnnotations (  )  const [virtual]

Returns all annotations directly present on this element.

Returns:
all annotations present on this element

virtual bool isAnnotationPresent ( TypedHandle< const Class vClassAnnotation  )  const [virtual]

Return true the specified annotation is present on this element.

Returns:
true the specified annotation is present on this element.

virtual AnnotatedElement::Handle addAnnotation ( Annotation::View  vAnnotation  )  [virtual]

Add the specified Annotation to this element.

Parameters:
 vAnnotation the annotation

virtual AnnotatedElement::View getSuperelement (  )  const [virtual]

Return the parent of this AnnotationElement or NULL if there is none.

The default implementation always returns NULL.

Returns:
the parent of this AnnotationElement or NULL if there is none

Reimplemented in Class.


The documentation for this class was generated from the following file:
Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.