org.exolab.javasource

Class JAnnotationType

java.lang.Object

org.exolab.javasource.JType

org.exolab.javasource.JStructure

org.exolab.javasource.JAnnotationType

All Implemented Interfaces:

JAnnotatedElement

public final class JAnnotationType
extends JStructure

Describes the definition of a annotation type class.

   JAnnotationType type = new JAnnotationType("RequestForEnhancement");
   type.addElement(new JAnnotationTypeElement("id", JType.Int));
   type.addElement(new JAnnotationTypeElement("synopsis", new JType("String")));
   JAnnotationTypeElement engineer;
   engineer = new JAnnotationTypeElement("engineer", new JType("String"));
   engineer.setDefaultString("\"[unassigned]\"");
   type.addElement(engineer);
   JAnnotationTypeElement date;
   date = new JAnnotationTypeElement("date", new JType("String"));
   date.setDefaultString("\"[unimplemented]\"");
   type.addElement(date);
 

outputs

   public @interface RequestForEnhancement {
       int id();
       String synopsis();
       String engineer() default "[unassigned]";
       String date() default "[unimplemented]";
   }
 

Author:

Andrew Fawcett

Field Summary

Fields inherited from class org.exolab.javasource.JType

BOOLEAN, BYTE, CHAR, DOUBLE, FLOAT, INT, LONG, SHORT

Constructor Summary

Constructors

Constructor and Description
JAnnotationType(java.lang.String name) Creates a JAnnotationType of the given name.

Method Summary

Modifier and Type	Method and Description
void	addElement(JAnnotationTypeElement jElement) Adds the given JAnnotationTypeElement to this JAnnotationType.
void	addField(JField jField) Not implemented.
void	addMember(JMember jMember) Adds the given JMember to this JAnnotationType.
JAnnotationTypeElement	getElement(java.lang.String name) Returns the member with the given name, or null if no member was found with the given name.
JAnnotationTypeElement[]	getElements() Returns an Array containing all our JAnnotationTypeElements.
JField	getField(java.lang.String name) Not implemented.
JField[]	getFields() Not implemented.
static void	main(java.lang.String[] args) Test.
void	print(JSourceWriter jsw) Prints the source code for this JAnnotationType to the given JSourceWriter.

Methods inherited from class org.exolab.javasource.JStructure

addAnnotation, addImport, addImport, addImport, addInterface, addInterface, getAnnotatedElementHelper, getAnnotation, getAnnotations, getFilename, getHeader, getImports, getInterfaceCount, getInterfaces, getJDocComment, getModifiers, getName, getPackageFromClassName, getPackageName, hasAnnotations, hasImport, isAnnotationPresent, isValidClassName, print, print, printHeader, printImportDeclarations, printlnWithPrefix, printPackageDeclaration, removeAnnotation, removeImport, setHeader, setPackageName

Methods inherited from class org.exolab.javasource.JType

changePackage, getLocalName, getName, getWrapperName, isArray, isPrimitive, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JAnnotationType

public JAnnotationType(java.lang.String name)

Creates a JAnnotationType of the given name.

Parameters:

name - Annotation name

Throws:

java.lang.IllegalArgumentException

Method Detail

addMember

public void addMember(JMember jMember)

Adds the given JMember to this JAnnotationType.

Specified by:

addMember in class JStructure

Parameters:

jMember - the JMember to add

addElement

public void addElement(JAnnotationTypeElement jElement)

Adds the given JAnnotationTypeElement to this JAnnotationType.

Parameters:

jElement - the element to add

getElement

public JAnnotationTypeElement getElement(java.lang.String name)

Returns the member with the given name, or null if no member was found with the given name.

Parameters:

name - the name of the member to return

Returns:

the member with the given name, or null if no member was found with the given name.

getElements

public JAnnotationTypeElement[] getElements()

Returns an Array containing all our JAnnotationTypeElements.

Returns:

an Array containing all our JAnnotationTypeElements.

addField

public void addField(JField jField)

Not implemented. Always throws a RuntimeException.

Specified by:

addField in class JStructure

Parameters:

jField - not used

See Also:

JStructure.addField(org.exolab.javasource.JField)

getField

public JField getField(java.lang.String name)

Not implemented. Always throws a RuntimeException.

Specified by:

getField in class JStructure

Parameters:

name - not used

Returns:

nothing is ever returned

See Also:

JStructure.getField(java.lang.String)

getFields

public JField[] getFields()

Not implemented. Always throws a RuntimeException.

Specified by:

getFields in class JStructure

Returns:

nothing is ever returned

print

public void print(JSourceWriter jsw)

Prints the source code for this JAnnotationType to the given JSourceWriter.

Specified by:

print in class JStructure

Parameters:

jsw - the JSourceWriter to print to. Must not be null.

main

public static void main(java.lang.String[] args)

Test.

Parameters:

args - command-line arguments