Class JConstant

java.lang.Object

org.exolab.javasource.JAnnotatedElementHelper

org.exolab.javasource.AbstractJField

org.exolab.javasource.JConstant

All Implemented Interfaces:

JAnnotatedElement, JMember

public final class JConstant
extends AbstractJField

A class which holds information about a constant. Modeled closely after the Java Reflection API. This class is part of package which is used to create source code in memory.

Since:

1.3

Author:

Werner Guttmann

Constructor Summary

Constructors

Constructor	Description
JConstant(JType type, String name)	Creates a new JConstant.
JConstant(JType type, String name, boolean makePrivate)	Creates a new JConstant.

Method Summary

Methods inherited from class AbstractJField

getComment, getDeclaringClass, getInitString, getModifiers, getName, getType, isDateTime, setComment, setComment, setDateTime, setDeclaringClass, setInitString, setModifiers, setName, toString

Modifier and Type	Method	Description
JDocComment	getComment()	Returns the JavaDoc comment describing this member.
JClass	getDeclaringClass()	Returns the class in which this JField has been declared.
String	getInitString()	Returns the initialization String for this JField.
JModifiers	getModifiers()	Returns the modifiers for this JField.
String	getName()	Returns the name of this JField.
JType	getType()	Returns the JType representing the type of this JField.
boolean	isDateTime()	Indicates whether this JField instance represents a field of type date/time.
void	setComment(String comment)	Sets the JavaDoc comment describing this JField.
void	setComment(JDocComment comment)	Sets the JavaDoc comment describing this JField.
void	setDateTime(boolean isDateTime)	To indicate whether this JField instance represents a field of type date/time.
protected void	setDeclaringClass(JClass declaringClass)	Sets the class that declares this JField.
void	setInitString(String init)	Sets the initialization string for this JField.
void	setModifiers(JModifiers modifiers)	Sets the access modifiers on this JField.
void	setName(String name)	Sets the name of this JField.
String	toString()

Methods inherited from class JAnnotatedElementHelper

addAnnotation, getAnnotation, getAnnotations, hasAnnotations, isAnnotationPresent, printAnnotations, removeAnnotation

Modifier and Type	Method	Description
final void	addAnnotation(JAnnotation annotation)	Adds a JAnnotation to this source element.
final JAnnotation	getAnnotation(JAnnotationType annotationType)	Retrieves a JAnnotation for the given JAnnotationType, returns null if no annotation has been set.
final JAnnotation[]	getAnnotations()	Returns a list of JAnnotation's already set on this source element.
final boolean	hasAnnotations()	Returns true if this source element has any annotations.
final boolean	isAnnotationPresent(JAnnotationType annotationType)	Returns true if a JAnnotation exists for the given JAnnotationType.
final boolean	printAnnotations(JSourceWriter jsw)	Outputs the list of annotations maintained by this object.
final JAnnotation	removeAnnotation(JAnnotationType annotationType)	Removes the JAnnotation from this source element for the given JAnnotationType.

Methods inherited from class Object

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

Constructor Details

JConstant

public JConstant(JType type,
 String name)

Creates a new JConstant.

Parameters:

type - JType of this new constant.

name - Name of this new constant.

JConstant

public JConstant(JType type,
 String name,
 boolean makePrivate)

Creates a new JConstant.

Parameters:

type - JType of this new constant.

name - Name of this new constant.

makePrivate - True if constant definition should have private visibility.