Package org.exolab.javasource
Class JAnnotatedElementHelper
java.lang.Object
org.exolab.javasource.JAnnotatedElementHelper
- All Implemented Interfaces:
JAnnotatedElement
- Direct Known Subclasses:
AbstractJField
,JConstructor
,JEnumConstant
,JMethodSignature
,JParameter
Implements JAnnotatedElement interface on behalf of other classes in this
package that implement this interface.
- Version:
- $Revision: 8009 $ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $
- Author:
- Andrew Fawcett
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal void
addAnnotation
(JAnnotation annotation) Adds a JAnnotation to this source element.final JAnnotation
getAnnotation
(JAnnotationType annotationType) Retrieves a JAnnotation for the given JAnnotationType, returns null if no annotation has been set.final JAnnotation[]
Returns a list of JAnnotation's already set on this source element.final boolean
Returns true if this source element has any annotations.final boolean
isAnnotationPresent
(JAnnotationType annotationType) Returns true if a JAnnotation exists for the given JAnnotationType.final boolean
Outputs the list of annotations maintained by this object.final JAnnotation
removeAnnotation
(JAnnotationType annotationType) Removes the JAnnotation from this source element for the given JAnnotationType.
-
Constructor Details
-
JAnnotatedElementHelper
public JAnnotatedElementHelper()Creates a JAnnodatedElementHelper.
-
-
Method Details
-
getAnnotation
Retrieves a JAnnotation for the given JAnnotationType, returns null if no annotation has been set.- Specified by:
getAnnotation
in interfaceJAnnotatedElement
- Parameters:
annotationType
- Annotation type to retrieve.- Returns:
- A JAnnotation for the given JAnnotationType.
-
getAnnotations
Returns a list of JAnnotation's already set on this source element.- Specified by:
getAnnotations
in interfaceJAnnotatedElement
- Returns:
- A list of all JAnnotations associated with this source element.
-
isAnnotationPresent
Returns true if a JAnnotation exists for the given JAnnotationType.- Specified by:
isAnnotationPresent
in interfaceJAnnotatedElement
- Parameters:
annotationType
- Annotation type to check for presence or absense.- Returns:
- True if a JAnnotation has been added for the given JAnnotationType.
-
addAnnotation
Adds a JAnnotation to this source element. An IllegalArgumentException is thrown if one already exists for the associated JAnnotationType.- Specified by:
addAnnotation
in interfaceJAnnotatedElement
- Parameters:
annotation
- A JAnnotation to add to this source element.
-
removeAnnotation
Removes the JAnnotation from this source element for the given JAnnotationType. An IllegalArgumentException is thrown if the provided JAnnotation isn't present.- Specified by:
removeAnnotation
in interfaceJAnnotatedElement
- Parameters:
annotationType
- Annotation type to remove.- Returns:
- The JAnnotation that was associated with this source element.
-
hasAnnotations
public final boolean hasAnnotations()Returns true if this source element has any annotations.- Specified by:
hasAnnotations
in interfaceJAnnotatedElement
- Returns:
- Returns true if this source element has any annotations.
-
printAnnotations
Outputs the list of annotations maintained by this object.- Parameters:
jsw
- the JSourceWriter to print the annotations to- Returns:
- true if at least one annotation was printed, false otherwise.
-