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

Class CodeBlock

java.lang.Object

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

All Implemented Interfaces:

ASTNode, Member

public class CodeBlock
extends java.lang.Object

A block of code in curly braces in a class.

This class implements the Member interface because a block can be a member (say, a static block in a class declaration), but usually it's not actually a Member, but something else, e.g. the body of a method, or the content of an if-statement, etc.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME The name of all CodeBlocks.

Constructor Summary

Constructors

Constructor and Description
CodeBlock(boolean isStatic, Offset startOffs)

Method Summary

Modifier and Type	Method and Description
void	add(CodeBlock child) Adds a child code block to this code block.
void	addLocalVariable(LocalVariable localVar) Adds a local variable to this code block.
boolean	containsOffset(int offs) Returns whether this code block contains the specified offset.
CodeBlock	getChildBlock(int index) Returns the specified child block.
int	getChildBlockCount()
CodeBlock	getDeepestCodeBlockContaining(int offs) Returns the deepest code block nested under this one (or this one itself) containing a given offset.
java.lang.String	getDocComment() Returns the doc comment for this member.
LocalVariable	getLocalVar(int index) Returns the specified local variable.
int	getLocalVarCount()
java.util.List<LocalVariable>	getLocalVarsBefore(int offs) Returns all local variables declared before a given offset, both in this code block and in all parent blocks.
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.
CodeBlock	getParent()
TypeDeclaration	getParentTypeDeclaration() Returns the parent type declaration of this member.
Type	getType() Returns null, since blocks don't have types.
boolean	isDeprecated() Returns whether this member is deprecated.
boolean	isStatic() Returns whether this block is a static block (in a class declaration).
void	setDeclarationEndOffset(Offset end)
protected void	setDeclarationOffsets(Offset start, Offset end) Sets the start and end offsets of this node.
void	setParent(CodeBlock parent)
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

Field Detail

NAME

public static final java.lang.String NAME

The name of all CodeBlocks.

See Also:

Constant Field Values

Constructor Detail

CodeBlock

public CodeBlock(boolean isStatic,
                 Offset startOffs)

Method Detail

add

public void add(CodeBlock child)

Adds a child code block to this code block.

Parameters:

child - The child code block to add.

See Also:

getChildBlock(int)

addLocalVariable

public void addLocalVariable(LocalVariable localVar)

Adds a local variable to this code block.

Parameters:

localVar - The local variable to add.

See Also:

getLocalVar(int)

containsOffset

public boolean containsOffset(int offs)

Returns whether this code block contains the specified offset.

Parameters:

offs - The offset.

Returns:

Whether this code block contains the offset.

getChildBlock

public CodeBlock getChildBlock(int index)

Returns the specified child block.

Parameters:

index - The index of the child block.

Returns:

The child block.

See Also:

getChildBlockCount()

getChildBlockCount

public int getChildBlockCount()

getDeepestCodeBlockContaining

public CodeBlock getDeepestCodeBlockContaining(int offs)

Returns the deepest code block nested under this one (or this one itself) containing a given offset.

Parameters:

offs - The offset to look for.

Returns:

The deepest-nested code block containing the offset, or null if this code block and none of its children contain the offset.

getDocComment

public java.lang.String getDocComment()

Description copied from interface: Member

Returns the doc comment for this member.

Returns:

This member's doc comment.

getLocalVar

public LocalVariable getLocalVar(int index)

Returns the specified local variable.

Parameters:

index - The index of the variable.

Returns:

The local variable.

See Also:

getLocalVarCount()

getLocalVarCount

public int getLocalVarCount()

getLocalVarsBefore

public java.util.List<LocalVariable> getLocalVarsBefore(int offs)

Returns all local variables declared before a given offset, both in this code block and in all parent blocks.

Parameters:

offs - The offset.

Returns:

The LocalVariables, or an empty list of none were declared before the offset.

getModifiers

public Modifiers getModifiers()

Description copied from interface: Member

Returns the modifiers of this member.

Returns:

The modifiers.

getParent

public CodeBlock getParent()

getType

public Type getType()

Returns null, since blocks don't have types.

Returns:

null always.

isDeprecated

public boolean isDeprecated()

Description copied from interface: Member

Returns whether this member is deprecated.

Returns:

Whether this member is deprecated.

isStatic

public boolean isStatic()

Returns whether this block is a static block (in a class declaration).

Specified by:

isStatic in interface Member

Returns:

Whether this is a static code block.

See Also:

Member.getModifiers()

setParent

public void setParent(CodeBlock parent)

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)

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