org.fife.rsta.ac.java.rjc.ast

Class Field

java.lang.Object

org.fife.rsta.ac.java.rjc.ast.Field

All Implemented Interfaces:

ASTNode, Member

public class Field
extends java.lang.Object

Represents a field in a class file.

Constructor Summary

Constructors

Constructor and Description
Field(Scanner s, Modifiers modifiers, Type type, Token t)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDocComment() Returns the doc comment for this member.
Modifiers	getModifiers() Returns the modifiers of this member.
java.lang.String	getName() Returns the "name" of this node.
int	getNameEndOffset() Returns the end offset of the "name" of this node.
int	getNameStartOffset() Returns the start offset of the "name" of this node.
TypeDeclaration	getParentTypeDeclaration() Returns the parent type declaration of this member.
Type	getType() Returns the type of this member.
boolean	isDeprecated() Returns whether this member is deprecated.
boolean	isStatic() Shortcut for getModifiers().isStatic(); useful since getModifiers() may return null.
void	setDeclarationEndOffset(Offset end)
protected void	setDeclarationOffsets(Offset start, Offset end) Sets the start and end offsets of this node.
void	setDeprecated(boolean deprecated)
void	setDocComment(java.lang.String comment)
void	setParentTypeDeclaration(TypeDeclaration dec) Sets the parent type declaration of this member.
java.lang.String	toString() Returns the name of this node (e.g.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fife.rsta.ac.java.rjc.ast.Member

getName, getNameEndOffset, getNameStartOffset

Constructor Detail

Field

public Field(Scanner s,
             Modifiers modifiers,
             Type type,
             Token t)

Method Detail

getDocComment

public java.lang.String getDocComment()

Description copied from interface: Member

Returns the doc comment for this member.

Returns:

This member's doc comment.

getModifiers

public Modifiers getModifiers()

Description copied from interface: Member

Returns the modifiers of this member.

Returns:

The modifiers.

getType

public Type getType()

Description copied from interface: Member

Returns the type of this member.

Returns:

This member's type.

isDeprecated

public boolean isDeprecated()

Description copied from interface: Member

Returns whether this member is deprecated.

Returns:

Whether this member is deprecated.

setDeprecated

public void setDeprecated(boolean deprecated)

setDocComment

public void setDocComment(java.lang.String comment)

getParentTypeDeclaration

public TypeDeclaration getParentTypeDeclaration()

Description copied from interface: Member

Returns the parent type declaration of this member.

Specified by:

getParentTypeDeclaration in interface Member

Returns:

The parent type declaration.

See Also:

Member.setParentTypeDeclaration(TypeDeclaration)

isStatic

public boolean isStatic()

Shortcut for getModifiers().isStatic(); useful since getModifiers() may return null.

Specified by:

isStatic in interface Member

Returns:

Whether this member is static.

See Also:

Member.getModifiers()

setParentTypeDeclaration

public void setParentTypeDeclaration(TypeDeclaration dec)

Sets the parent type declaration of this member.

Specified by:

setParentTypeDeclaration in interface Member

Parameters:

dec - The parent type declaration.

See Also:

Member.getParentTypeDeclaration()

getName

public java.lang.String getName()

Returns the "name" of this node. This will be the name of the method, the name of the member or local variable, etc. For CodeBlocks it will be CodeBlock.NAME.

Note that this may not be unique. For example, a class with an overloaded method will have multiple methods with the same "name," just with different signatures.

Specified by:

getName in interface ASTNode

Returns:

The "name" of this node.

getNameEndOffset

public int getNameEndOffset()

Returns the end offset of the "name" of this node.

Specified by:

getNameEndOffset in interface ASTNode

Returns:

The end offset.

getNameStartOffset

public int getNameStartOffset()

Returns the start offset of the "name" of this node.

Specified by:

getNameStartOffset in interface ASTNode

Returns:

The start offset.

setDeclarationEndOffset

public void setDeclarationEndOffset(Offset end)

setDeclarationOffsets

protected void setDeclarationOffsets(Offset start,
                                     Offset end)

Sets the start and end offsets of this node.

Parameters:

start - The start offset.

end - The end offset.

toString

public java.lang.String toString()

Returns the name of this node (e.g. the value of getName()). Subclasses can override this method if appropriate.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this node.