Package org.exolab.javasource
Class JAnnotation
java.lang.Object
org.exolab.javasource.JAnnotation
JAnnotation represents a single annotation against a code element. The methods described on the
JAnnotatedElement interface are used to associate JAnnotation's with various other objects in
this package describing Java code elements.
The print method outputs annotations in various forms (as described in the Java Language Specification Third Edition) based on the methods called.
For "Marker Annotation", construct with the appropriate JAnnotationType.
JAnnotationType preliminaryType = new JAnnotationType("Preliminary"); JAnnotation preliminary = new JAnnotation(preliminaryType);outputs
@Preliminary()For "Single Element Annotation", construct as above and call the setValue(value) method to set the value of the "value" element of the annotation type.
JAnnotationType copyrightType = new JAnnotationType("Copyright"); JAnnotation copyright = new JAnnotation(copyrightType); copyright.setValue("\"2002 Yoyodyne Systems, Inc., All rights reserved.\"");outputs
@Copyright("2002 Yoyodyne Propulsion Systems, Inc., All rights reserved.")For "Normal Annotation," construct as above then call the appropriate setValue methods that accept an "elementName" parameter.
JAnnotationType requestType = new JAnnotationType("RequestForEnhancement"); JAnnotation request = new JAnnotation(requestType); request.setElementValue("id", "2868724"); request.setElementValue("synopsis", "\"Provide time-travel functionality\""); request.setElementValue("engineer", "\"Mr. Peabody\""); request.setElementValue("date", "\"4/1/2004\"");outputs
@RequestForEnhancement( id = 2868724, sysopsis = "Provide time-travel functionality", engineer = "Mr. Peabody", date = "4/1/2004")"Complex" annotations are also supported via the various setValue methods that take a JAnnotation object.
JAnnotationType nameType = new JAnnotationType("Name"); JAnnotationType authorType = new JAnnotationType("Author"); JAnnotation author = new JAnnotation(authorType); JAnnotation name = new JAnnotation(nameType); name.setElementValue("first", "\"Joe\""); name.setElementValue("last", "\"Hacker\""); author.setValue(name);outputs
@Author(@Name( first = "Joe", last = "Hacker"))Finally annotation elements whose types are arrays are supported via the setValue methods that take arrays:
JAnnotationType endorsersType = new JAnnotationType("Endorsers"); JAnnotation endorsers = new JAnnotation(endorsersType); endorsers.setValue(new String[] {"\"Children\"", "\"Unscrupulous dentists\""});outputs
@Endorsers( { "Children", "Unscrupulous dentists" })Note: Conditional element values are not currently supported. However the setValue methods taking String values can be used to output this construct literally if desired.
- Version:
- $Revision$ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $
- Author:
- Andrew Fawcett
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionJAnnotation
(JAnnotationType annotationType) Constructs a JAnnotation for the given annotation type. -
Method Summary
Modifier and TypeMethodDescriptionReturns the JAnnotationType associated with this JAnnotation.String[]
Returns the names of the elements set by this annotation.getElementValue
(String elementName) For the provided element name, returns the annotation element value when it is a String.getElementValueAnnotation
(String elementName) For the provided element name, returns the annotation element value when it is a JAnnotation.getElementValueAnnotationList
(String elementName) For the provided element name, returns the annotation element value when it is an array of JAnnotation.String[]
getElementValueList
(String elementName) For the provided element name, returns the annotation element value when it is an array of String.getElementValueObject
(String elementName) Returns the given annotation element value as Object, typically used if the value type is not known.getValue()
Returns the annotation element value when it is a String.Returns the annotation element value when it is an annotation.void
print
(JSourceWriter jsw) Prints the source code for this JAnnotation to the given JSourceWriter.void
setElementValue
(String elementName, String stringValue) Adds an annotation element name=value pair.void
setElementValue
(String elementName, String[] stringValues) Adds an annotation element name=list pair.void
setElementValue
(String elementName, JAnnotation annotationValue) Adds an annotation element name=annotation pair.void
setElementValue
(String elementName, JAnnotation[] annotationValues) Adds an annotation element name=array of annotations.void
Sets the "value" annotation element value.void
Sets the "value" annotation element value as a list.void
setValue
(JAnnotation annotationValue) Sets the "value" annotation element value as an annotation.void
setValue
(JAnnotation[] annotationValues) Sets the "value" annotation element value as a list of annotation values.
-
Field Details
-
VALUE
-
-
Constructor Details
-
JAnnotation
Constructs a JAnnotation for the given annotation type.- Parameters:
annotationType
- Annotation type.
-
-
Method Details
-
getAnnotationType
Returns the JAnnotationType associated with this JAnnotation.- Returns:
- The JAnnotationType associated with this JAnnotation..
-
setValue
Sets the "value" annotation element value.- Parameters:
stringValue
- Literal String value.
-
setValue
Sets the "value" annotation element value as a list.- Parameters:
stringValue
- Array of literal String values.
-
setValue
Sets the "value" annotation element value as an annotation.- Parameters:
annotationValue
- JAnnotation to be used as this JAnnotation's value.
-
setValue
Sets the "value" annotation element value as a list of annotation values.- Parameters:
annotationValues
- Array of JAnnotations to be used as this JAnnotation's value.
-
setElementValue
-
setElementValue
-
setElementValue
Adds an annotation element name=annotation pair.- Parameters:
elementName
- Name of this annotation element.annotationValue
- Annotation to be used as the value.
-
setElementValue
Adds an annotation element name=array of annotations.- Parameters:
elementName
- Name of this annotation element.annotationValues
- Array of annotations to be used as the value.
-
getValue
Returns the annotation element value when it is a String.- Returns:
- The annotation element value.
-
getValueAnnotation
Returns the annotation element value when it is an annotation.- Returns:
- The annotation element value when it is an annotation.
-
getElementValue
-
getElementValueList
-
getElementValueObject
Returns the given annotation element value as Object, typically used if the value type is not known. This will either be a String or JAnnotation or an array of String or an array of JAnnotation.- Parameters:
elementName
- Element to return the value of.- Returns:
- Annotation element value as Object.
-
getElementValueAnnotation
For the provided element name, returns the annotation element value when it is a JAnnotation.- Parameters:
elementName
- Element to return the value of.- Returns:
- The annotation element value.
-
getElementValueAnnotationList
For the provided element name, returns the annotation element value when it is an array of JAnnotation.- Parameters:
elementName
- Element to return the value of.- Returns:
- The annotation element value.
-
getElementNames
Returns the names of the elements set by this annotation.- Returns:
- Array of element names.
-
print
Prints the source code for this JAnnotation to the given JSourceWriter.- Parameters:
jsw
- the JSourceWriter to print to. Must not be null.
-