org.exolab.javasource

Class JField

public 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: 1.3 $ $Date: 2005/02/27 00:30:28 $

Author: Keith Visco

Constructor Summary
JField(JType type, String name)
Method Summary
JDocCommentgetComment()
Returns the comment describing this member.
JClassgetDeclaringClass()
Returns the class in which this JField has been declared
StringgetInitString()
Returns the initialization String for this JField
JModifiersgetModifiers()
Returns the modifiers for this JField
StringgetName()
Returns the name of this JField
JTypegetType()
Returns the JType represting the type of this JField
voidsetComment(JDocComment comment)
Sets the comment describing this member.
voidsetComment(String comment)
Sets the comment describing this member.
protected voidsetDeclaringClass(JClass declaringClass)
voidsetInitString(String init)
Sets the initialization string for this JField; Allows some flexibility in declaring default values.
voidsetModifiers(JModifiers modifiers)
voidsetName(String name)
Sets the name of this JField
StringtoString()

Constructor Detail

JField

public JField(JType type, String name)

Method Detail

getComment

public JDocComment getComment()
Returns the comment describing this member.

Returns: the 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

Returns: the modifiers for this JField

getName

public String getName()
Returns the name of this JField

Returns: the name of this JField

getType

public JType getType()
Returns the JType represting the type of this JField

Returns: the JClass represting the type of this JField

setComment

public void setComment(JDocComment comment)
Sets the comment describing this member.

Parameters: comment the JDocComment for this member

setComment

public void setComment(String comment)
Sets the comment describing this member.

Parameters: comment the JDocComment for this member

setDeclaringClass

protected void setDeclaringClass(JClass declaringClass)

setInitString

public void setInitString(String init)
Sets the initialization string for this JField; Allows some flexibility in declaring default values.

Parameters: init the initialization string for this member.

setModifiers

public void setModifiers(JModifiers modifiers)

setName

public void setName(String name)
Sets the name of this JField

Parameters: name the name of this JField

Throws: IllegalArgumentException when the name is not a valid Java member name, or if a member with the given name already exists in the declaring class

toString

public String toString()
Intalio Inc. (C) 1999-2004. All rights reserved http://www.intalio.com