de.uka.ilkd.key.java.declaration

Class InterfaceDeclaration

java.lang.Object

de.uka.ilkd.key.java.JavaSourceElement

de.uka.ilkd.key.java.JavaProgramElement

de.uka.ilkd.key.java.JavaNonTerminalProgramElement

de.uka.ilkd.key.java.declaration.JavaDeclaration

de.uka.ilkd.key.java.declaration.TypeDeclaration

de.uka.ilkd.key.java.declaration.InterfaceDeclaration

All Implemented Interfaces:

ClassType, ClassTypeContainer, Member, ProgramModelElement, Type, Declaration, MemberDeclaration, TypeDeclarationContainer, ModelElement, NamedModelElement, NamedProgramElement, NonTerminalProgramElement, ProgramElement, ScopeDefiningElement, SourceElement, TypeScope, VariableScope, SVSubstitute

public class InterfaceDeclaration
extends TypeDeclaration

Interface declaration.

Field Summary

Fields

Modifier and Type	Field and Description
protected Extends	extending

Fields inherited from class de.uka.ilkd.key.java.declaration.TypeDeclaration

fullName, isLibrary, members, name, parentIsInterfaceDeclaration

Fields inherited from class de.uka.ilkd.key.java.declaration.JavaDeclaration

modArray

Constructor Summary

Constructors

Constructor and Description
InterfaceDeclaration()
InterfaceDeclaration(ExtList children, ProgramElementName fullName, boolean isLibrary) uses children list to create non-anonymous class
InterfaceDeclaration(Modifier[] modifiers, ProgramElementName name, Extends extended, MemberDeclaration[] members, boolean isLibrary) Construct a new outer or member interface class.
InterfaceDeclaration(Modifier[] modifiers, ProgramElementName name, ProgramElementName fullName, Extends extended, MemberDeclaration[] members, boolean isLibrary) Construct a new outer or member interface class.
InterfaceDeclaration(ProgramElementName name)

Method Summary

Modifier and Type	Method and Description
ProgramElement	getChildAt(int index) Returns the child at the specified index in this node's "virtual" child array
int	getChildCount() Returns the number of children of this node.
Extends	getExtendedTypes() Get extended types.
ImmutableList<KeYJavaType>	getSupertypes() returns the local declared supertypes
boolean	isAbstract() Interfaces are always abstract.
boolean	isInterface() Checks if this class type denotes an interface.
boolean	isNative() Interfaces are never native.
boolean	isPrivate() Interfaces are never private.
boolean	isProtected() Interfaces are never protected.
boolean	isStrictFp() Interfaces are never strictfp.
boolean	isSynchronized() Interfaces are never synchronized.
boolean	isTransient() Interfaces are never transient.
boolean	isVolatile() Interfaces are never volatile.
void	prettyPrint(PrettyPrinter p) Pretty printing the source element.
void	visit(Visitor v) calls the corresponding method of a visitor in order to perform some action/transformation on this element

Methods inherited from class de.uka.ilkd.key.java.declaration.TypeDeclaration

equals, getAllFields, getAllMethods, getAllSupertypes, getAllTypes, getConstructors, getDefaultValue, getFields, getFirstElement, getFullName, getLastElement, getMembers, getMethods, getName, getPackage, getProgramElementName, getTypeDeclarationAt, getTypeDeclarationCount, getTypes, isFinal, isLibraryClass, isPublic, isStatic

Methods inherited from class de.uka.ilkd.key.java.declaration.JavaDeclaration

getModifiers, getStateCount, getVisibilityModifier, isGhost, isModel

Methods inherited from class de.uka.ilkd.key.java.JavaNonTerminalProgramElement

compatibleBlockSize, computeHashCode, equalsModRenaming, getArrayPos, match, matchChildren

Methods inherited from class de.uka.ilkd.key.java.JavaProgramElement

getComments, hashCode, prettyPrintMain, reuseSignature

Methods inherited from class de.uka.ilkd.key.java.JavaSourceElement

getEndPosition, getFirstElementIncludingBlocks, getParentClass, getPositionInfo, getRelativePosition, getStartPosition, setParentClass, toSource, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.uka.ilkd.key.java.Declaration

getModifiers

Methods inherited from interface de.uka.ilkd.key.java.ProgramElement

getComments, match

Methods inherited from interface de.uka.ilkd.key.java.SourceElement

equalsModRenaming, getEndPosition, getFirstElementIncludingBlocks, getPositionInfo, getRelativePosition, getStartPosition

Field Detail

extending

protected final Extends extending

Constructor Detail

InterfaceDeclaration

public InterfaceDeclaration()

InterfaceDeclaration

public InterfaceDeclaration(Modifier[] modifiers,
                            ProgramElementName name,
                            ProgramElementName fullName,
                            Extends extended,
                            MemberDeclaration[] members,
                            boolean isLibrary)

Construct a new outer or member interface class.

InterfaceDeclaration

public InterfaceDeclaration(Modifier[] modifiers,
                            ProgramElementName name,
                            Extends extended,
                            MemberDeclaration[] members,
                            boolean isLibrary)

Construct a new outer or member interface class.

InterfaceDeclaration

public InterfaceDeclaration(ExtList children,
                            ProgramElementName fullName,
                            boolean isLibrary)

uses children list to create non-anonymous class

Parameters:

children - an ExtList that may contain: an Extends (as pointer to a class), ProgramElementName (as name), several MemberDeclaration (as members of the type), a parentIsInterfaceDeclaration (indicating if parent is interface), several Modifier (as modifiers of the type decl), a Comment

fullName - the fully qualified ProgramElementName of the declared type

isLibrary - a boolean flag indicating if this interface is part of a library (library interfaces come often with a specification and are only available as bytecode)

InterfaceDeclaration

public InterfaceDeclaration(ProgramElementName name)

Method Detail

getChildCount

public int getChildCount()

Returns the number of children of this node.

Returns:

an int giving the number of children of this node

getChildAt

public ProgramElement getChildAt(int index)

Returns the child at the specified index in this node's "virtual" child array

Parameters:

index - an index into this node's "virtual" child array

Returns:

the program element at the given position

Throws:

java.lang.ArrayIndexOutOfBoundsException - if index is out of bounds

getExtendedTypes

public Extends getExtendedTypes()

Get extended types.

Returns:

the extends.

isAbstract

public boolean isAbstract()

Interfaces are always abstract.

Specified by:

isAbstract in interface ClassType

Overrides:

isAbstract in class TypeDeclaration

Returns:

true if this member is abstract, false otherwise.

See Also:

ClassType.isInterface()

isNative

public boolean isNative()

Interfaces are never native.

Overrides:

isNative in class JavaDeclaration

isProtected

public boolean isProtected()

Interfaces are never protected.

Specified by:

isProtected in interface Member

Specified by:

isProtected in interface MemberDeclaration

Overrides:

isProtected in class TypeDeclaration

Returns:

true if this member is protected, false otherwise.

isPrivate

public boolean isPrivate()

Interfaces are never private.

Specified by:

isPrivate in interface Member

Specified by:

isPrivate in interface MemberDeclaration

Overrides:

isPrivate in class TypeDeclaration

Returns:

true if this member is private, false otherwise.

isStrictFp

public boolean isStrictFp()

Interfaces are never strictfp.

Specified by:

isStrictFp in interface Member

Specified by:

isStrictFp in interface MemberDeclaration

Overrides:

isStrictFp in class TypeDeclaration

Returns:

true if this member is strictfp, false otherwise.

isSynchronized

public boolean isSynchronized()

Interfaces are never synchronized.

Overrides:

isSynchronized in class JavaDeclaration

isTransient

public boolean isTransient()

Interfaces are never transient.

Overrides:

isTransient in class JavaDeclaration

isVolatile

public boolean isVolatile()

Interfaces are never volatile.

Overrides:

isVolatile in class JavaDeclaration

isInterface

public boolean isInterface()

Description copied from interface: ClassType

Checks if this class type denotes an interface.

Returns:

true if this object represents an interface, false if it is an ordinary class.

getSupertypes

public ImmutableList<KeYJavaType> getSupertypes()

returns the local declared supertypes

Specified by:

getSupertypes in interface ClassType

Specified by:

getSupertypes in class TypeDeclaration

Returns:

the array of locally defined supertypes of this type.

visit

public void visit(Visitor v)

calls the corresponding method of a visitor in order to perform some action/transformation on this element

Parameters:

v - the Visitor

prettyPrint

public void prettyPrint(PrettyPrinter p)
                 throws java.io.IOException

Description copied from class: JavaSourceElement

Pretty printing the source element.

Specified by:

prettyPrint in interface SourceElement

Overrides:

prettyPrint in class JavaProgramElement

Parameters:

p - a pretty printer.

Throws:

java.io.IOException - occasionally thrown.