org.exolab.javasource
public final class JAnnotation extends Object
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.
Field Summary | |
---|---|
static String | VALUE
Name of a single element. |
Constructor Summary | |
---|---|
JAnnotation(JAnnotationType annotationType)
Constructs a JAnnotation for the given annotation type.
|
Method Summary | |
---|---|
JAnnotationType | getAnnotationType()
Returns the JAnnotationType associated with this JAnnotation.
|
String[] | getElementNames()
Returns the names of the elements set by this annotation.
|
String | getElementValue(String elementName)
For the provided element name, returns the annotation element value when
it is a String.
|
JAnnotation | getElementValueAnnotation(String elementName)
For the provided element name, returns the annotation element value when
it is a JAnnotation.
|
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.
|
Object | getElementValueObject(String elementName)
Returns the given annotation element value as Object, typically used if
the value type is not known. |
String | getValue()
Returns the annotation element value when it is a String.
|
JAnnotation | getValueAnnotation()
Returns the annotation element value when it is an annotation.
|
static void | main(String[] args)
Test. |
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 | setValue(String stringValue)
Sets the "value" annotation element value.
|
void | setValue(String[] stringValue)
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.
|
Parameters: annotationType annotation type
Returns: the JAnnotationType associated with this JAnnotation.
Returns: array of element names.
Parameters: elementName element to return the value of
Returns: the annotation element value.
Parameters: elementName element to return the value of
Returns: the annotation element value.
Parameters: elementName element to return the value of
Returns: the annotation element value.
Parameters: elementName element to return the value of
Returns: the annotation element value.
Parameters: elementName element to return the value of
Returns: annotation element value as Object
Returns: the annotation element value.
Returns: the annotation element value when it is an annotation.
Parameters: args command-line arguments.
Parameters: jsw the JSourceWriter to print to. Must not be null.
Parameters: elementName name of this annotation element stringValue value of this annotation element
Parameters: elementName name of this annotation element stringValues string array value of this annotation element
Parameters: elementName name of this annotation element annotationValue annotation to be used as the value
Parameters: elementName name of this annotation element annotationValues array of annotations to be used as the value
Parameters: stringValue literal String value
Parameters: stringValue Array of literal String values
Parameters: annotationValue JAnnotation to be used as this JAnnotation's value
Parameters: annotationValues array of JAnnotations to be used as this JAnnotation's value