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

Class AbstractASTNode

java.lang.Object

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

All Implemented Interfaces:

ASTNode

Direct Known Subclasses:

AbstractMember, AbstractTypeDeclarationNode, CompilationUnit, EnumBody, ImportDeclaration, LocalVariable, Package

abstract class AbstractASTNode
extends java.lang.Object
implements ASTNode

Base implementation of an AST node.

Version:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
private Offset	endOffs
private java.lang.String	name
private Offset	startOffs

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractASTNode(java.lang.String name, Offset start)
protected	AbstractASTNode(java.lang.String name, Offset start, Offset end)

Method Summary

Modifier and Type	Method	Description
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.
void	setDeclarationEndOffset(Offset end)
protected void	setDeclarationOffsets(Offset start, Offset end)	Sets the start and end offsets of this node.
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

Field Detail

name

private java.lang.String name

startOffs

private Offset startOffs

endOffs

private Offset endOffs

Constructor Detail

AbstractASTNode

protected AbstractASTNode(java.lang.String name,
                          Offset start)

AbstractASTNode

protected AbstractASTNode(java.lang.String name,
                          Offset start,
                          Offset end)

Method Detail

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.