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

java.lang.Object
  org.fife.rsta.ac.java.rjc.ast.LocalVariable
      org.fife.rsta.ac.java.rjc.ast.FormalParameter

All Implemented Interfaces:

ASTNode

public class FormalParameter
extends LocalVariable

A parameter to a method.

Version:

1.0

Author:

Robert Futrell

Constructor Summary

FormalParameter(Scanner s, boolean isFinal, Type type, int offs, String name, List annotations)

Method Summary

int	getAnnotationCount()
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.
String	toString() Overridden to return "getType() getName()".

Methods inherited from class org.fife.rsta.ac.java.rjc.ast.LocalVariable

getType, isFinal

Methods inherited from class java.lang.Object

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

Constructor Detail

FormalParameter

public FormalParameter(Scanner s,
                       boolean isFinal,
                       Type type,
                       int offs,
                       String name,
                       List annotations)

Method Detail

getAnnotationCount

public int getAnnotationCount()

toString

public String toString()

Overridden to return "getType() getName()".

Returns:

This parameter, as a string.

getName

public 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.