Class AbstractTypeDeclarationNode

java.lang.Object

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

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 AbstractASTNode
implements TypeDeclaration

A base class for type declaration nodes.

Version:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
private Offset	bodyEndOffs
private Offset	bodyStartOffs
private List<TypeDeclaration>	childTypes
private boolean	deprecated
private String	docComment
private List<Member>	memberList
private Modifiers	modifiers
private TypeDeclaration	parentType
private Package	pkg

Constructor Summary

Constructors

Constructor	Description
AbstractTypeDeclarationNode(String name, Offset start)
AbstractTypeDeclarationNode(String name, Offset start, Offset end)

Method Summary

Modifier and Type	Method	Description
void	addMember(Member member)	Adds a member to this type declaration.
void	addTypeDeclaration(TypeDeclaration type)	Adds a type declaration to this container.
boolean	getBodyContainsOffset(int offs)	Returns whether this type declaration contains the specified offset.
int	getBodyEndOffset()	Returns the end-offset of the type declaration's body.
int	getBodyStartOffset()	Returns the start-offset of the type declaration's body.
TypeDeclaration	getChildType(int index)	Returns a child type by index.
TypeDeclaration	getChildTypeAtOffset(int offs)	Returns the child type declaration of this one that contains the specified offset, if any.
int	getChildTypeCount()	Returns the number of child types.
String	getDocComment()	Returns the doc comment for this type declaration.
Iterator<Field>	getFieldIterator()	Returns an iterator over all fields defined in this type.
Member	getMember(int index)	Returns a member by index.
int	getMemberCount()	Returns the number of members in this type declaration.
Iterator<Member>	getMemberIterator()	Returns an iterator over all members of this type.
Iterator<Method>	getMethodIterator()	Returns an iterator over all methods defined in this type.
List<Method>	getMethodsByName(String name)	Returns all methods declared in this type with the given name.
Modifiers	getModifiers()	Returns the modifiers of this type declaration.
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.
private void	init()
boolean	isDeprecated()	Returns whether this type declaration is deprecated.
boolean	isStatic()	Shortcut for getModifiers().isStatic(); useful since getModifiers() may return null.
void	setBodyEndOffset(Offset end)
void	setBodyStartOffset(Offset start)
void	setDeprecated(boolean deprecated)
void	setDocComment(String comment)	Sets the doc comment for this type declaration.
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.
String	toString()	Returns the name of this node (e.g.

Methods inherited from class AbstractASTNode

getName, getNameEndOffset, getNameStartOffset, setDeclarationEndOffset, setDeclarationOffsets

Methods inherited from class Object

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

Methods inherited from interface ASTNode

getNameEndOffset, getNameStartOffset

Methods inherited from interface TypeDeclaration

getName, getTypeString

Field Details

pkg

private Package pkg

modifiers

private Modifiers modifiers

parentType

private TypeDeclaration parentType

childTypes

private List<TypeDeclaration> childTypes

bodyStartOffs

private Offset bodyStartOffs

bodyEndOffs

private Offset bodyEndOffs

deprecated

private boolean deprecated

docComment

private String docComment

memberList

private List<Member> memberList

Constructor Details

AbstractTypeDeclarationNode

public AbstractTypeDeclarationNode(String name,
 Offset start)

AbstractTypeDeclarationNode

public AbstractTypeDeclarationNode(String name,
 Offset start,
 Offset end)

Method Details

addMember

public void addMember(Member member)

Adds a member to this type declaration.

Parameters:

member - The member to add.

addTypeDeclaration

public void addTypeDeclaration(TypeDeclaration type)

Description copied from interface: TypeDeclarationContainer

Adds a type declaration to this container.

Specified by:

addTypeDeclaration in interface TypeDeclarationContainer

Parameters:

type - The new type declaration.

getBodyContainsOffset

public boolean getBodyContainsOffset(int offs)

Description copied from interface: TypeDeclaration

Returns whether this type declaration contains the specified offset.

Specified by:

getBodyContainsOffset in interface TypeDeclaration

Parameters:

offs - The offset to check.

Returns:

Whether the offset is contained.

getBodyEndOffset

public int getBodyEndOffset()

Description copied from interface: TypeDeclaration

Returns the end-offset of the type declaration's body.

Specified by:

getBodyEndOffset in interface TypeDeclaration

Returns:

The end offset.

See Also:

• TypeDeclaration.getBodyStartOffset()

getBodyStartOffset

public int getBodyStartOffset()

Description copied from interface: TypeDeclaration

Returns the start-offset of the type declaration's body.

Specified by:

getBodyStartOffset in interface TypeDeclaration

Returns:

The start offset.

See Also:

• TypeDeclaration.getBodyEndOffset()

getChildType

public TypeDeclaration getChildType(int index)

Description copied from interface: TypeDeclaration

Returns a child type by index.

Specified by:

getChildType in interface TypeDeclaration

Parameters:

index - The index.

Returns:

The child type.

See Also:

• TypeDeclaration.getChildTypeCount()

getChildTypeAtOffset

public TypeDeclaration getChildTypeAtOffset(int offs)

Description copied from interface: TypeDeclaration

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 any child type declaration.

getChildTypeCount

public int getChildTypeCount()

Description copied from interface: TypeDeclaration

Returns the number of child types.

Specified by:

getChildTypeCount in interface TypeDeclaration

Returns:

The number of child types.

See Also:

• TypeDeclaration.getChildType(int)

getDocComment

public String getDocComment()

Description copied from interface: TypeDeclaration

Returns the doc comment for this type declaration.

Specified by:

getDocComment in interface TypeDeclaration

Returns:

The doc comment.

See Also:

• TypeDeclaration.setDocComment(String)

getFieldIterator

public Iterator<Field> getFieldIterator()

Description copied from interface: TypeDeclaration

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)

Description copied from interface: TypeDeclaration

Returns a member by index.

Specified by:

getMember in interface TypeDeclaration

Parameters:

index - The index.

Returns:

The member.

See Also:

• TypeDeclaration.getMemberCount()
• TypeDeclaration.getMemberIterator()

getMemberCount

public int getMemberCount()

Description copied from interface: TypeDeclaration

Returns the number of members in this type declaration.

Specified by:

getMemberCount in interface TypeDeclaration

Returns:

The number of members.

See Also:

• TypeDeclaration.getMember(int)
• TypeDeclaration.getMemberIterator()

getMemberIterator

public Iterator<Member> getMemberIterator()

Description copied from interface: TypeDeclaration

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()
• TypeDeclaration.getMember(int)
• TypeDeclaration.getMemberCount()

getMethodIterator

public Iterator<Method> getMethodIterator()

Description copied from interface: TypeDeclaration

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 List<Method> getMethodsByName(String name)

Description copied from interface: TypeDeclaration

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 String getName(boolean fullyQualified)

Description copied from interface: TypeDeclaration

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)

init

private void init()

isDeprecated

public boolean isDeprecated()

Description copied from interface: TypeDeclaration

Returns whether this type declaration is deprecated.

Specified by:

isDeprecated in interface TypeDeclaration

Returns:

Whether this type declaration is deprecated.

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(String comment)

Description copied from interface: TypeDeclaration

Sets the doc comment for this type declaration.

Specified by:

setDocComment in interface TypeDeclaration

Parameters:

comment - The new doc comment.

See Also:

• TypeDeclaration.getDocComment()

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 String toString()

Description copied from class: AbstractASTNode

Returns the name of this node (e.g. the value of AbstractASTNode.getName()). Subclasses can override this method if appropriate.

Overrides:

toString in class AbstractASTNode

Returns:

A string representation of this node.