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.
getAnnotationType
public JAnnotationType getAnnotationType()
Returns the JAnnotationType associated with this JAnnotation.
- the JAnnotationType associated with this JAnnotation.
getElementNames
public String[] getElementNames()
Returns the names of the elements set by this annotation.
getElementValue
public String getElementValue(String elementName)
For the provided element name, returns the annotation element value when
it is a String.
elementName
- element to return the value of
- the annotation element value.
getElementValueAnnotation
public JAnnotation getElementValueAnnotation(String elementName)
For the provided element name, returns the annotation element value when
it is a JAnnotation.
elementName
- element to return the value of
- the annotation element value.
getElementValueAnnotationList
public JAnnotation[] getElementValueAnnotationList(String elementName)
For the provided element name, returns the annotation element value when
it is an array of JAnnotation.
elementName
- element to return the value of
- the annotation element value.
getElementValueList
public String[] getElementValueList(String elementName)
For the provided element name, returns the annotation element value when
it is an array of String.
elementName
- element to return the value of
- the annotation element value.
getElementValueObject
public Object getElementValueObject(String elementName)
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.
elementName
- element to return the value of
- annotation element value as Object
getValue
public String getValue()
Returns the annotation element value when it is a String.
- the annotation element value.
getValueAnnotation
public JAnnotation getValueAnnotation()
Returns the annotation element value when it is an annotation.
- the annotation element value when it is an annotation.
main
public static void main(String[] args)
Test.
args
- command-line arguments.
print
public void print(JSourceWriter jsw)
Prints the source code for this JAnnotation to the given JSourceWriter.
jsw
- the JSourceWriter to print to. Must not be null.
setElementValue
public void setElementValue(String elementName,
String stringValue)
Adds an annotation element name=value pair.
elementName
- name of this annotation elementstringValue
- value of this annotation element
setElementValue
public void setElementValue(String elementName,
String[] stringValues)
Adds an annotation element name=list pair.
elementName
- name of this annotation elementstringValues
- string array value of this annotation element
setElementValue
public void setElementValue(String elementName,
JAnnotation annotationValue)
Adds an annotation element name=annotation pair.
elementName
- name of this annotation elementannotationValue
- annotation to be used as the value
setElementValue
public void setElementValue(String elementName,
JAnnotation[] annotationValues)
Adds an annotation element name=array of annotations.
elementName
- name of this annotation elementannotationValues
- array of annotations to be used as the value
setValue
public void setValue(String stringValue)
Sets the "value" annotation element value.
stringValue
- literal String value
setValue
public void setValue(String[] stringValue)
Sets the "value" annotation element value as a list.
stringValue
- Array of literal String values
setValue
public void setValue(JAnnotation annotationValue)
Sets the "value" annotation element value as an annotation.
annotationValue
- JAnnotation to be used as this JAnnotation's value
setValue
public void setValue(JAnnotation[] annotationValues)
Sets the "value" annotation element value as a list of annotation values.
annotationValues
- array of JAnnotations to be used as this
JAnnotation's value