ACS-10.0 Java API: org.exolab.javasource.JAnnotationTypeElement Class Reference

Inheritance diagram for org.exolab.javasource.JAnnotationTypeElement:

List of all members.

Public Member Functions
	JAnnotationTypeElement (String name, JType type)
JModifiers	getModifiers ()
void	setName (String name) throws IllegalArgumentException
String	getName ()
JType	getType ()
String	getDefaultString ()
void	setDefaultString (String defaultString)
void	setComment (JDocComment comment)
void	setComment (String comment)
JDocComment	getComment ()
void	print (JSourceWriter jsw)
Static Public Member Functions
static void	main (String[] args)

Detailed Description

A class that holds information about a given annotation type element

Author:: Andrew Fawcett

Constructor & Destructor Documentation

org.exolab.javasource.JAnnotationTypeElement.JAnnotationTypeElement	(	String	name,
		JType	type
	)

Constructs a JAnnotationTypeElement with a given name and type

Parameters:

	name
	type

References org.exolab.javasource.JDocComment.appendComment(), and org.exolab.javasource.JAnnotationTypeElement.setName().

Referenced by org.exolab.javasource.JAnnotationTypeElement.main().

Member Function Documentation

JDocComment org.exolab.javasource.JAnnotationTypeElement.getComment ( )

Returns the comment describing this member.

Returns:: the comment describing this member, or null if no comment has been set.

String org.exolab.javasource.JAnnotationTypeElement.getDefaultString ( )

Gets the initialization string for this JAnnotationTypeElement

Returns:: Gets the initialization string for this JAnnotationTypeElement

JModifiers org.exolab.javasource.JAnnotationTypeElement.getModifiers ( )

Returns the modifiers for this JAnnotationTypeElement

Returns:: the modifiers for this JAnnotationTypeElement

Implements org.exolab.javasource.JMember.

String org.exolab.javasource.JAnnotationTypeElement.getName ( )

Returns the name of this JAnnotationTypeElement

Returns:: the name of this JAnnotationTypeElement

Implements org.exolab.javasource.JMember.

JType org.exolab.javasource.JAnnotationTypeElement.getType ( )

Returns the JType represting the type of this JAnnotationTypeElement

Returns:: the JClass represting the type of this JAnnotationTypeElement

static void org.exolab.javasource.JAnnotationTypeElement.main ( String[] args ) [static]

Parameters:

args

References org.exolab.javasource.JSourceWriter.flush(), org.exolab.javasource.JAnnotationTypeElement.JAnnotationTypeElement(), org.exolab.javasource.JAnnotationTypeElement.print(), org.exolab.javasource.JAnnotationTypeElement.setDefaultString(), and org.exolab.javasource.JSourceWriter.writeln().

void org.exolab.javasource.JAnnotationTypeElement.print ( JSourceWriter jsw )

Outputs the annotation type element

Parameters:

jsw

References org.exolab.javasource.JDocComment.print(), org.exolab.javasource.JType.toString(), and org.exolab.javasource.JSourceWriter.write().

Referenced by org.exolab.javasource.JAnnotationTypeElement.main(), and org.exolab.javasource.JAnnotationType.print().

void org.exolab.javasource.JAnnotationTypeElement.setComment ( JDocComment comment )

Sets the comment describing this member.

Parameters:

comment

the JDocComment for this member

void org.exolab.javasource.JAnnotationTypeElement.setComment ( String comment )

Sets the comment describing this member.

Parameters:

comment

the JDocComment for this member

References org.exolab.javasource.JDocComment.setComment().

void org.exolab.javasource.JAnnotationTypeElement.setDefaultString ( String defaultString )

Sets the initialization string for this JAnnotationTypeElement; Allows some flexibility in declaring default values.

Parameters:

init

the initialization string for this member.

Referenced by org.exolab.javasource.JAnnotationTypeElement.main(), and org.exolab.javasource.JAnnotationType.main().

void org.exolab.javasource.JAnnotationTypeElement.setName ( String name ) throws IllegalArgumentException

Sets the name of this JAnnotationTypeElement

Parameters:

name

the name of this JAnnotationTypeElement

Exceptions:

IllegalArgumentException

when the name is not a valid Java member name

Referenced by org.exolab.javasource.JAnnotationTypeElement.JAnnotationTypeElement().

The documentation for this class was generated from the following file:

JAnnotationTypeElement.java

All Classes Namespaces Files Functions Variables Enumerations Properties