org.exolab.javasource

Class JField

Implemented Interfaces:
JAnnotatedElement, JMember

public final class JField
extends JAnnotatedElementHelper
implements JMember

A class which holds information about a field. Modelled closely after the Java Reflection API. This class is part of package which is used to create source code in memory.
Version:
$Revision: 6324 $ $Date: 2005-02-26 17:30:28 -0700 (Sat, 26 Feb 2005) $
Author:
Keith Visco

Constructor Summary

JField(JType type, String name)
Creates a new JField.

Method Summary

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 org.exolab.javasource.JAnnotatedElementHelper

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

Constructor Details

JField

public JField(JType type,
              String name)
Creates a new JField.
Parameters:
type - JType of this new field
name - name of this new field

Method Details

getComment

public JDocComment getComment()
Returns the JavaDoc comment describing this member.
Returns:
the JavaDoc comment describing this member, or null if no comment has been set.

getDeclaringClass

public JClass getDeclaringClass()
Returns the class in which this JField has been declared.
Returns:
the class in which this JField has been declared.

getInitString

public String getInitString()
Returns the initialization String for this JField.
Returns:
the initialization String for this JField, or null if no initialization String was specified.

getModifiers

public JModifiers getModifiers()
Returns the modifiers for this JField.
Specified by:
getModifiers in interface JMember
Returns:
the modifiers for this JField.

getName

public String getName()
Returns the name of this JField.
Specified by:
getName in interface JMember
Returns:
the name of this JField.

getType

public JType getType()
Returns the JType representing the type of this JField.
Returns:
the JType representing the type of this JField.

isDateTime

public boolean isDateTime()
Indicates whether this JField instance represents a field of type date/time.
Returns:
True if this field is of type date/time.

setComment

public void setComment(String comment)
Sets the JavaDoc comment describing this JField.
Parameters:
comment - the JavaDoc comment for this JField

setComment

public void setComment(JDocComment comment)
Sets the JavaDoc comment describing this JField.
Parameters:
comment - the JavaDoc comment for this JField

setDateTime

public void setDateTime(boolean isDateTime)
To indicate whether this JField instance represents a field of type date/time.
Parameters:
isDateTime - True if this field is of type date/time.

setDeclaringClass

protected void setDeclaringClass(JClass declaringClass)
Sets the class that declares this JField.
Parameters:
declaringClass - the class in which this Jfield is declared

setInitString

public void setInitString(String init)
Sets the initialization string for this JField. This allows some flexibility in declaring default values.
Parameters:
init - the initialization string for this member

setModifiers

public void setModifiers(JModifiers modifiers)
Sets the access modifiers on this JField.
Parameters:
modifiers - the access modifiers to be used for this JField

setName

public void setName(String name)
Sets the name of this JField.
Parameters:
name - the name of this JField

toString

public String toString()
See Also:
{@inheritDoc}

Intalio Inc. (C) 1999-2006. All rights reserved http://www.intalio.com