net.cscott.gjdoc

Interface FieldDoc

public interface FieldDoc extends MemberDoc

The FieldDoc class represents a field in a java class.

Version: $Id: FieldDoc.java,v 1.4 2003/03/27 02:04:43 cananian Exp $

Author: C. Scott Ananian (cscott@cscott.net)

See Also: com.sun.javadoc.FieldDoc

Method Summary
Object	constantValue() Get the value of a constant field, wrapped in an object if it has a primitive type.
String	constantValueExpression() The text of a Java language expression whose value is the value of the constant.
boolean	isTransient() Return true if this field is transient.
boolean	isVolatile() Return true if this field is volatile.
List<SerialFieldTag>	serialFieldTags() Return the @serialField tags for this item.
Type	type() Return the type of this field.

Method Detail

constantValue

public Object constantValue()

Get the value of a constant field, wrapped in an object if it has a primitive type. If the field is not constant, returns null.

constantValueExpression

public String constantValueExpression()

The text of a Java language expression whose value is the value of the constant. The expression uses no identifiers other than primitive literals. If the field is not constant, returns null.

isTransient

public boolean isTransient()

Return true if this field is transient.

isVolatile

public boolean isVolatile()

Return true if this field is volatile.

serialFieldTags

public List<SerialFieldTag> serialFieldTags()

Return the @serialField tags for this item.

type

public Type type()

Return the type of this field.