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

Class Method

java.lang.Object

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

All Implemented Interfaces:

ASTNode, Member

public class Method
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Method(Scanner s, Modifiers modifiers, Type type, Token nameToken, java.util.List<FormalParameter> params, java.util.List<java.lang.String> thrownTypeNames)

Method Summary

Modifier and Type	Method and Description
CodeBlock	getBody()
boolean	getBodyContainsOffset(int offs)
int	getBodyEndOffset()
int	getBodyStartOffset()
java.lang.String	getDocComment()
Modifiers	getModifiers()
java.lang.String	getName() Returns the "name" of this node.
java.lang.String	getNameAndParameters()
int	getNameEndOffset() Returns the end offset of the "name" of this node.
int	getNameStartOffset() Returns the start offset of the "name" of this node.
FormalParameter	getParameter(int index)
int	getParameterCount()
java.util.Iterator<FormalParameter>	getParameterIterator()
TypeDeclaration	getParentTypeDeclaration()
int	getThrownTypeNameCount()
Type	getType()
boolean	isConstructor()
boolean	isDeprecated()
boolean	isStatic() Shortcut for getModifiers().isStatic(); useful since getModifiers() may return null.
void	setBody(CodeBlock body)
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)
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

Method

public Method(Scanner s,
              Modifiers modifiers,
              Type type,
              Token nameToken,
              java.util.List<FormalParameter> params,
              java.util.List<java.lang.String> thrownTypeNames)

Method Detail

getBody

public CodeBlock getBody()

getBodyContainsOffset

public boolean getBodyContainsOffset(int offs)

getBodyEndOffset

public int getBodyEndOffset()

getBodyStartOffset

public int getBodyStartOffset()

getDocComment

public java.lang.String getDocComment()

getModifiers

public Modifiers getModifiers()

getNameAndParameters

public java.lang.String getNameAndParameters()

getParameter

public FormalParameter getParameter(int index)

getParameterCount

public int getParameterCount()

getParameterIterator

public java.util.Iterator<FormalParameter> getParameterIterator()

getThrownTypeNameCount

public int getThrownTypeNameCount()

getType

public Type getType()

isConstructor

public boolean isConstructor()

isDeprecated

public boolean isDeprecated()

setBody

public void setBody(CodeBlock body)

setDeprecated

public void setDeprecated(boolean deprecated)

setDocComment

public void setDocComment(java.lang.String comment)

getParentTypeDeclaration

public TypeDeclaration getParentTypeDeclaration()

Specified by:

getParentTypeDeclaration in interface Member

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)

Specified by:

setParentTypeDeclaration in interface Member

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.