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

Class AbstractTypeDeclarationNode

java.lang.Object

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

All Implemented Interfaces:

ASTNode, TypeDeclaration, TypeDeclarationContainer

Direct Known Subclasses:

EnumDeclaration, NormalClassDeclaration, NormalInterfaceDeclaration

public abstract class AbstractTypeDeclarationNode
extends java.lang.Object
implements TypeDeclaration

Constructor Summary

Constructors

Constructor and Description
AbstractTypeDeclarationNode(java.lang.String name, Offset start)
AbstractTypeDeclarationNode(java.lang.String name, Offset start, Offset end)

Method Summary

Modifier and Type	Method and Description
void	addMember(Member member)
void	addTypeDeclaration(TypeDeclaration type)
boolean	getBodyContainsOffset(int offs)
int	getBodyEndOffset()
int	getBodyStartOffset()
TypeDeclaration	getChildType(int index)
TypeDeclaration	getChildTypeAtOffset(int offs) Returns the child type declaration of this one that contains the specified offset, if any.
int	getChildTypeCount()
java.lang.String	getDocComment()
java.util.Iterator<Field>	getFieldIterator() Returns an iterator over all fields defined in this type.
Member	getMember(int index)
int	getMemberCount()
java.util.Iterator<Member>	getMemberIterator() Returns an iterator over all members of this type.
java.util.Iterator<Method>	getMethodIterator() Returns an iterator over all methods defined in this type.
java.util.List<Method>	getMethodsByName(java.lang.String name) Returns all methods declared in this type with the given name.
Modifiers	getModifiers() Returns the modifiers of this type declaration.
java.lang.String	getName() Returns the "name" of this node.
java.lang.String	getName(boolean fullyQualified) Returns the name of this type.
int	getNameEndOffset() Returns the end offset of the "name" of this node.
int	getNameStartOffset() Returns the start offset of the "name" of this node.
Package	getPackage() Returns the package this type is in.
TypeDeclaration	getParentType() Returns the parent type declaration.
boolean	isDeprecated()
boolean	isStatic() Shortcut for getModifiers().isStatic(); useful since getModifiers() may return null.
void	setBodyEndOffset(Offset end)
void	setBodyStartOffset(Offset start)
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	setModifiers(Modifiers modifiers)
void	setPackage(Package pkg) Sets the package this type is in.
void	setParentType(TypeDeclaration parentType) Sets the parent type declaration for this type declaration.
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.TypeDeclaration

getName, getTypeString

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

getNameEndOffset, getNameStartOffset

Constructor Detail

AbstractTypeDeclarationNode

public AbstractTypeDeclarationNode(java.lang.String name,
                                   Offset start)

AbstractTypeDeclarationNode

public AbstractTypeDeclarationNode(java.lang.String name,
                                   Offset start,
                                   Offset end)

Method Detail

addMember

public void addMember(Member member)

addTypeDeclaration

public void addTypeDeclaration(TypeDeclaration type)

Specified by:

addTypeDeclaration in interface TypeDeclarationContainer

getBodyContainsOffset

public boolean getBodyContainsOffset(int offs)

Specified by:

getBodyContainsOffset in interface TypeDeclaration

getBodyEndOffset

public int getBodyEndOffset()

Specified by:

getBodyEndOffset in interface TypeDeclaration

getBodyStartOffset

public int getBodyStartOffset()

Specified by:

getBodyStartOffset in interface TypeDeclaration

getChildType

public TypeDeclaration getChildType(int index)

Specified by:

getChildType in interface TypeDeclaration

getChildTypeAtOffset

public TypeDeclaration getChildTypeAtOffset(int offs)

Returns the child type declaration of this one that contains the specified offset, if any.

Specified by:

getChildTypeAtOffset in interface TypeDeclaration

Parameters:

offs - The offset.

Returns:

The type declaration, or null if the offset is outside of any child type declaration.

getChildTypeCount

public int getChildTypeCount()

Specified by:

getChildTypeCount in interface TypeDeclaration

getDocComment

public java.lang.String getDocComment()

Specified by:

getDocComment in interface TypeDeclaration

getFieldIterator

public java.util.Iterator<Field> getFieldIterator()

Returns an iterator over all fields defined in this type.

Specified by:

getFieldIterator in interface TypeDeclaration

Returns:

The iterator.

See Also:

TypeDeclaration.getMethodIterator(), TypeDeclaration.getMemberIterator()

getMember

public Member getMember(int index)

Specified by:

getMember in interface TypeDeclaration

getMemberCount

public int getMemberCount()

Specified by:

getMemberCount in interface TypeDeclaration

getMemberIterator

public java.util.Iterator<Member> getMemberIterator()

Returns an iterator over all members of this type. Note that an exception may be thrown if a method is added to this type while this iterator is being used.

Specified by:

getMemberIterator in interface TypeDeclaration

Returns:

The iterator.

See Also:

TypeDeclaration.getMethodIterator()

getMethodIterator

public java.util.Iterator<Method> getMethodIterator()

Returns an iterator over all methods defined in this type.

Specified by:

getMethodIterator in interface TypeDeclaration

Returns:

The iterator.

See Also:

TypeDeclaration.getFieldIterator(), TypeDeclaration.getMemberIterator()

getMethodsByName

public java.util.List<Method> getMethodsByName(java.lang.String name)

Returns all methods declared in this type with the given name. Does not check for methods with this name in subclasses.

Specified by:

getMethodsByName in interface TypeDeclaration

Parameters:

name - The name to check for.

Returns:

Any method overloads with that name, or an empty list if none.

getModifiers

public Modifiers getModifiers()

Description copied from interface: TypeDeclaration

Returns the modifiers of this type declaration.

Specified by:

getModifiers in interface TypeDeclaration

Returns:

The modifier list. This may be null if no modifiers were specified.

getName

public java.lang.String getName(boolean fullyQualified)

Returns the name of this type.

Specified by:

getName in interface TypeDeclaration

Parameters:

fullyQualified - Whether the name returned should be fully qualified.

Returns:

The type's name.

See Also:

TypeDeclaration.getName()

getPackage

public Package getPackage()

Returns the package this type is in.

Specified by:

getPackage in interface TypeDeclaration

Returns:

The package, or null if it's in the default package.

getParentType

public TypeDeclaration getParentType()

Returns the parent type declaration.

Specified by:

getParentType in interface TypeDeclaration

Returns:

The parent type declaration, or null if there isn't one.

See Also:

TypeDeclaration.setParentType(TypeDeclaration)

isDeprecated

public boolean isDeprecated()

Specified by:

isDeprecated in interface TypeDeclaration

isStatic

public boolean isStatic()

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

Specified by:

isStatic in interface TypeDeclaration

Returns:

Whether this type declaration is static.

See Also:

TypeDeclaration.getModifiers()

setBodyEndOffset

public void setBodyEndOffset(Offset end)

setBodyStartOffset

public void setBodyStartOffset(Offset start)

setDeprecated

public void setDeprecated(boolean deprecated)

setDocComment

public void setDocComment(java.lang.String comment)

Specified by:

setDocComment in interface TypeDeclaration

setModifiers

public void setModifiers(Modifiers modifiers)

setPackage

public void setPackage(Package pkg)

Sets the package this type is in.

Parameters:

pkg - The package, or null if this is in the default package.

See Also:

getPackage()

setParentType

public void setParentType(TypeDeclaration parentType)

Sets the parent type declaration for this type declaration.

Specified by:

setParentType in interface TypeDeclaration

Parameters:

parentType - The parent type declaration.

See Also:

TypeDeclaration.getParentType()

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.

Returns:

A string representation of this node.

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.