Package com.tonic.analysis.source.ast.decl

Class InterfaceDecl

java.lang.Object

com.tonic.analysis.source.ast.decl.InterfaceDecl

All Implemented Interfaces:

ASTNode, TypeDecl

public final class InterfaceDecl
extends Object
implements TypeDecl

An interface declaration in the source AST, with its extended interfaces, type parameters, members, and nested types.

Constructor Summary

Constructors

Constructor	Description
InterfaceDecl(String name)	Creates an interface with no source position.
InterfaceDecl(String name, SourceLocation location)	Creates an interface with no modifiers or members.

Method Summary

Modifier and Type	Method	Description
<T> T	accept(SourceVisitor<T> visitor)	Accepts a visitor for this node.
InterfaceDecl	addAnnotation(AnnotationExpr annotation)	Appends an annotation.
InterfaceDecl	addExtendedInterface(SourceType iface)	Appends a super-interface to the extends clause.
InterfaceDecl	addField(FieldDecl field)	Appends a field.
InterfaceDecl	addInnerType(TypeDecl innerType)	Appends a nested type.
InterfaceDecl	addMethod(MethodDecl method)	Appends a method.
InterfaceDecl	addModifier(Modifier modifier)	Adds one modifier.
InterfaceDecl	addTypeParameter(SourceType typeParam)	Appends a type parameter.
NodeList<AnnotationExpr>	getAnnotations()
List<ASTNode>	getChildren()	Lists the direct children a node holds, in source order.
NodeList<SourceType>	getExtendedInterfaces()
NodeList<FieldDecl>	getFields()
NodeList<TypeDecl>	getInnerTypes()
SourceLocation	getLocation()	Gets the source location of this node.
NodeList<MethodDecl>	getMethods()
Set<Modifier>	getModifiers()
String	getName()
ASTNode	getParent()	Gets the parent node in the AST tree.
NodeList<SourceType>	getTypeParameters()
void	setName(String name)	Renames the interface.
void	setParent(ASTNode parent)	Records the node this declaration hangs under.
String	toString()
InterfaceDecl	withModifiers(Set<Modifier> modifiers)	Replaces the modifier set.
InterfaceDecl	withName(String name)	Renames the interface.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.tonic.analysis.source.ast.ASTNode

deepClone, findAll, findAll, findAncestor, findFirst, findFirst, getRoot, isDescendantOf, remove, replaceWith, stream, stream, walk

Methods inherited from interface com.tonic.analysis.source.ast.decl.TypeDecl

getField, getInnerType, getMethod, isAbstract, isFinal, isPrivate, isProtected, isPublic, isStatic

Constructor Detail

InterfaceDecl

public InterfaceDecl(String name,
                     SourceLocation location)

Creates an interface with no modifiers or members.

Parameters:

name - the simple name

location - the source position, or null for UNKNOWN

InterfaceDecl

public InterfaceDecl(String name)

Creates an interface with no source position.

Parameters:

name - the simple name

Method Detail

getName

public String getName()

Specified by:

getName in interface TypeDecl

Returns:

the name

setName

public void setName(String name)

Renames the interface.

Parameters:

name - the new simple name

getModifiers

public Set<Modifier> getModifiers()

Specified by:

getModifiers in interface TypeDecl

Returns:

the modifiers

getAnnotations

public NodeList<AnnotationExpr> getAnnotations()

Specified by:

getAnnotations in interface TypeDecl

Returns:

the annotations

getExtendedInterfaces

public NodeList<SourceType> getExtendedInterfaces()

Returns:

the extended interfaces

getTypeParameters

public NodeList<SourceType> getTypeParameters()

Returns:

the type parameters

getFields

public NodeList<FieldDecl> getFields()

Specified by:

getFields in interface TypeDecl

Returns:

the fields

getMethods

public NodeList<MethodDecl> getMethods()

Specified by:

getMethods in interface TypeDecl

Returns:

the methods

getInnerTypes

public NodeList<TypeDecl> getInnerTypes()

Specified by:

getInnerTypes in interface TypeDecl

Returns:

the inner types

getLocation

public SourceLocation getLocation()

Description copied from interface: ASTNode

Gets the source location of this node.

Specified by:

getLocation in interface ASTNode

Returns:

the location

getParent

public ASTNode getParent()

Description copied from interface: ASTNode

Gets the parent node in the AST tree.

Specified by:

getParent in interface ASTNode

Returns:

the parent

setParent

public void setParent(ASTNode parent)

Records the node this declaration hangs under.

Specified by:

setParent in interface ASTNode

Parameters:

parent - the enclosing node

withName

public InterfaceDecl withName(String name)

Renames the interface.

Parameters:

name - the new simple name

Returns:

this declaration

withModifiers

public InterfaceDecl withModifiers(Set<Modifier> modifiers)

Replaces the modifier set.

Parameters:

modifiers - the modifiers to hold

Returns:

this declaration

addModifier

public InterfaceDecl addModifier(Modifier modifier)

Adds one modifier.

Parameters:

modifier - the modifier to add

Returns:

this declaration

addAnnotation

public InterfaceDecl addAnnotation(AnnotationExpr annotation)

Appends an annotation.

Parameters:

annotation - the annotation to add

Returns:

this declaration

addExtendedInterface

public InterfaceDecl addExtendedInterface(SourceType iface)

Appends a super-interface to the extends clause.

Parameters:

iface - the interface type to add

Returns:

this declaration

addTypeParameter

public InterfaceDecl addTypeParameter(SourceType typeParam)

Appends a type parameter.

Parameters:

typeParam - the type parameter to add

Returns:

this declaration

addField

public InterfaceDecl addField(FieldDecl field)

Appends a field.

Parameters:

field - the field to add

Returns:

this declaration

addMethod

public InterfaceDecl addMethod(MethodDecl method)

Appends a method.

Parameters:

method - the method to add

Returns:

this declaration

addInnerType

public InterfaceDecl addInnerType(TypeDecl innerType)

Appends a nested type.

Parameters:

innerType - the nested declaration to add

Returns:

this declaration

getChildren

public List<ASTNode> getChildren()

Description copied from interface: ASTNode

Lists the direct children a node holds, in source order.

Specified by:

getChildren in interface ASTNode

Returns:

the direct children, empty for a leaf

accept

public <T> T accept(SourceVisitor<T> visitor)

Description copied from interface: ASTNode

Accepts a visitor for this node.

Specified by:

accept in interface ASTNode

Type Parameters:

T - the return type of the visitor

Parameters:

visitor - the visitor to accept

Returns:

the result from the visitor

toString

public String toString()

Overrides:

toString in class Object