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

Interface TypeDeclaration

All Superinterfaces:

ASTNode, TypeDeclarationContainer

All Known Implementing Classes:

AbstractTypeDeclarationNode, EnumDeclaration, NormalClassDeclaration, NormalInterfaceDeclaration

public interface TypeDeclaration
extends ASTNode, TypeDeclarationContainer

Method Summary

Modifier and Type	Method and Description
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 type, unqualified.
java.lang.String	getName(boolean fullyQualified) Returns the name of this type.
Package	getPackage() Returns the package this type is in.
TypeDeclaration	getParentType() Returns the parent type declaration.
java.lang.String	getTypeString()
boolean	isDeprecated()
boolean	isStatic() Shortcut for getModifiers().isStatic(); useful since getModifiers() may return null.
void	setDocComment(java.lang.String comment)
void	setParentType(TypeDeclaration parentType) Sets the parent type declaration for this type declaration.

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

getNameEndOffset, getNameStartOffset

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

addTypeDeclaration

Method Detail

getBodyContainsOffset

boolean getBodyContainsOffset(int offs)

getBodyEndOffset

int getBodyEndOffset()

getBodyStartOffset

int getBodyStartOffset()

getChildType

TypeDeclaration getChildType(int index)

getChildTypeAtOffset

TypeDeclaration getChildTypeAtOffset(int offs)

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

Parameters:

offs - The offset.

Returns:

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

getChildTypeCount

int getChildTypeCount()

getDocComment

java.lang.String getDocComment()

getFieldIterator

java.util.Iterator<Field> getFieldIterator()

Returns an iterator over all fields defined in this type.

Returns:

The iterator.

See Also:

getMethodIterator(), getMemberIterator()

getMember

Member getMember(int index)

getMemberCount

int getMemberCount()

getMemberIterator

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.

Returns:

The iterator.

See Also:

getMethodIterator()

getMethodIterator

java.util.Iterator<Method> getMethodIterator()

Returns an iterator over all methods defined in this type.

Returns:

The iterator.

See Also:

getFieldIterator(), getMemberIterator()

getMethodsByName

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.

Parameters:

name - The name to check for.

Returns:

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

getModifiers

Modifiers getModifiers()

Returns the modifiers of this type declaration.

Returns:

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

getName

java.lang.String getName()

Returns the name of this type, unqualified.

Specified by:

getName in interface ASTNode

Returns:

The name of this type.

See Also:

getName(boolean)

getName

java.lang.String getName(boolean fullyQualified)

Returns the name of this type.

Parameters:

fullyQualified - Whether the name returned should be fully qualified.

Returns:

The type's name.

See Also:

getName()

getPackage

Package getPackage()

Returns the package this type is in.

Returns:

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

getParentType

TypeDeclaration getParentType()

Returns the parent type declaration.

Returns:

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

See Also:

setParentType(TypeDeclaration)

getTypeString

java.lang.String getTypeString()

isDeprecated

boolean isDeprecated()

isStatic

boolean isStatic()

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

Returns:

Whether this type declaration is static.

See Also:

getModifiers()

setDocComment

void setDocComment(java.lang.String comment)

setParentType

void setParentType(TypeDeclaration parentType)

Sets the parent type declaration for this type declaration.

Parameters:

parentType - The parent type declaration.

See Also:

getParentType()