C++ Client API Reference for Oracle Coherence: coherence/lang/AnnotatedElement.hpp Source File

00001 /*
00002  * Copyright (c) 2000, 2020, Oracle and/or its affiliates.
00003  *
00004  * Licensed under the Universal Permissive License v 1.0 as shown at
00005  * http://oss.oracle.com/licenses/upl.
00006  */
00007 #ifndef COH_ANNOTATED_ELEMENT_HPP
00008 #define COH_ANNOTATED_ELEMENT_HPP
00009 
00010 #include "coherence/lang/compatibility.hpp"
00011 
00012 #include "coherence/lang/abstract_spec.hpp"
00013 #include "coherence/lang/Annotation.hpp"
00014 #include "coherence/lang/FinalHandle.hpp"
00015 #include "coherence/lang/ObjectArray.hpp"
00016 
00017 
00018 
00019 COH_OPEN_NAMESPACE2(coherence,lang)
00020 
00021 // ----- forward declarations -----------------------------------------------
00022 
00023 class Class;
00024 
00025 /**
00026  * AnnotatedElement represents an annotated element.
00027  *
00028  * @author mf 2011.03.01
00029  *
00030  * @since Coherence 3.7.1
00031  */
00032 class COH_EXPORT AnnotatedElement
00033     : public abstract_spec<AnnotatedElement>
00034     {
00035     // ----- constructors ---------------------------------------------------
00036 
00037     protected:
00038         /**
00039          * Construct an AnnotatedElement.
00040          */
00041         AnnotatedElement();
00042 
00043 
00044     // ----- AnnotatedElement interface -------------------------------------
00045 
00046     public:
00047         /**
00048          * Returns this element's annotation for the specified type if such an
00049          * annotation is present, else NULL.
00050          *
00051          * @param vClassAnnotation  the annotation type
00052          *
00053          * @return the Annotation or NULL if not present
00054          */
00055         virtual Annotation::View getAnnotation(TypedHandle<const Class> vClassAnnotation) const;
00056 
00057         /**
00058          * Returns all annotations present on this element.
00059          *
00060          * @return all annotations present on this element
00061          */
00062         virtual ObjectArray::View getAnnotations() const;
00063 
00064         /**
00065          * Returns all annotations directly present on this element.
00066          *
00067          * @return all annotations present on this element
00068          */
00069         virtual ObjectArray::View getDeclaredAnnotations() const;
00070 
00071         /**
00072          * Return true the specified annotation is present on this element.
00073          *
00074          * @return true the specified annotation is present on this element.
00075          */
00076         virtual bool isAnnotationPresent(TypedHandle<const Class> vClassAnnotation) const;
00077 
00078         /**
00079          * Add the specified Annotation to this element.
00080          *
00081          * @param vAnnotation  the annotation
00082          */
00083         virtual AnnotatedElement::Handle addAnnotation(Annotation::View vAnnotation);
00084 
00085         /**
00086          * Return the parent of this AnnotationElement or NULL if there is none.
00087          *
00088          * The default implementation always returns NULL.
00089          *
00090          * @return the parent of this AnnotationElement or NULL if there is none
00091          */
00092         virtual AnnotatedElement::View getSuperelement() const;
00093 
00094 
00095     // ----- data members ---------------------------------------------------
00096 
00097     protected:
00098         /**
00099          * The map of resolved annotations, key'd by annotation type Class
00100          */
00101         mutable FinalHandle<Object> f_hMapAnnotations;
00102 
00103         /**
00104          * The list of declared annotations.
00105          */
00106         FinalHandle<Object> f_hListAnnotationsDeclared;
00107     };
00108 
00109 COH_CLOSE_NAMESPACE2
00110 
00111 #endif // COH_ANNOTATED_ELEMENT_HPP