de.uka.ilkd.key.java.declaration

Class TypeDeclaration

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ArrayDeclaration, ClassDeclaration, InterfaceDeclaration, SuperArrayDeclaration

public abstract class TypeDeclaration
extends JavaDeclaration
implements NamedProgramElement, MemberDeclaration, TypeDeclarationContainer, ClassType, VariableScope, TypeScope

Type declaration. taken from COMPOST and changed to achieve an immutable structure

Field Summary

Fields

Modifier and Type	Field and Description
protected ProgramElementName	fullName
protected boolean	isLibrary
protected ImmutableArray<MemberDeclaration>	members
protected ProgramElementName	name
protected boolean	parentIsInterfaceDeclaration

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

modArray

Constructor Summary

Constructors

Constructor and Description
TypeDeclaration()
TypeDeclaration(ExtList children, ProgramElementName fullName, boolean isLibrary)
TypeDeclaration(ExtList children, ProgramElementName name, ProgramElementName fullName, boolean isLibrary)
TypeDeclaration(Modifier[] mods, ProgramElementName name, ProgramElementName fullName, MemberDeclaration[] members, boolean parentIsInterfaceDeclaration, boolean isLibrary) Type declaration.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ImmutableList<Field>	getAllFields(Services services) [dlohner] The given parameter is obsolete with this implementation.
ImmutableList<Method>	getAllMethods(Services services) TO BE IMPLEMENTED
ImmutableList<ClassType>	getAllSupertypes(Services services) TO BE IMPLEMENTED
ImmutableList<ClassType>	getAllTypes(Services services) TO BE IMPLEMENTED
ImmutableList<Constructor>	getConstructors(Services services) TO BE IMPLEMENTED
Literal	getDefaultValue() returns the default value of the given type according to JLS 4.5.5
ImmutableList<Field>	getFields(Services services) TO BE IMPLEMENTED
SourceElement	getFirstElement() Finds the source element that occurs first in the source.
String	getFullName() Returns the maximal expanded name including all applicable qualifiers.
SourceElement	getLastElement() Finds the source element that occurs last in the source.
ImmutableArray<MemberDeclaration>	getMembers() Get members.
ImmutableList<Method>	getMethods(Services services) TO BE IMPLEMENTED
String	getName() Get name.
Package	getPackage(Services s) TO BE IMPLEMENTED
ProgramElementName	getProgramElementName() Get ProgramElementName.
abstract ImmutableList<KeYJavaType>	getSupertypes() returns the local declared supertypes
TypeDeclaration	getTypeDeclarationAt(int index)
int	getTypeDeclarationCount() Get the number of type declarations in this container.
ImmutableList<ClassType>	getTypes(Services services) TO BE IMPLEMENTED
boolean	isAbstract() Test whether the declaration is abstract.
boolean	isFinal() Test whether the declaration is final.
boolean	isLibraryClass()
boolean	isPrivate() Test whether the declaration is private.
boolean	isProtected() Test whether the declaration is protected.
boolean	isPublic() Test whether the declaration is public.
boolean	isStatic() Test whether the declaration is static.
boolean	isStrictFp() Test whether the declaration is strictfp.

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

getModifiers, getStateCount, getVisibilityModifier, isGhost, isModel, isNative, isSynchronized, isTransient, isVolatile

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

compatibleBlockSize, equalsModRenaming, getArrayPos, hashCode, match, matchChildren

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

getComments, prettyPrint, 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.abstraction.ClassType

isInterface

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

getChildAt, getChildCount

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, prettyPrint, visit

Field Detail

name

protected final ProgramElementName name

fullName

protected final ProgramElementName fullName

members

protected final ImmutableArray<MemberDeclaration> members

parentIsInterfaceDeclaration

protected final boolean parentIsInterfaceDeclaration

isLibrary

protected final boolean isLibrary

Constructor Detail

TypeDeclaration

public TypeDeclaration()

TypeDeclaration

public TypeDeclaration(Modifier[] mods,
                       ProgramElementName name,
                       ProgramElementName fullName,
                       MemberDeclaration[] members,
                       boolean parentIsInterfaceDeclaration,
                       boolean isLibrary)

Type declaration.

Parameters:

mods - a modifier array.

name - ProgramElementName of the type

members - an array containing the memberdeclarations of this type

TypeDeclaration

public TypeDeclaration(ExtList children,
                       ProgramElementName name,
                       ProgramElementName fullName,
                       boolean isLibrary)

Parameters:

children - an ExtList of children.

name - the ProgramElementName of the type May contain: several MemberDeclaration (as members of the type), a parentIsInterfaceDeclaration (indicating if parent is interface), several Modifier (as modifiers of the type decl), Comments

TypeDeclaration

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

Parameters:

children - an ExtList of children. May contain: a 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), Comments

Method Detail

getFirstElement

public SourceElement getFirstElement()

Description copied from class: JavaSourceElement

Finds the source element that occurs first in the source. The default implementation returns this element, which is correct for all terminal program elements, and many non terminals such as statements and prefixed operators.

Specified by:

getFirstElement in interface SourceElement

Overrides:

getFirstElement in class JavaSourceElement

Returns:

the first source element in the syntactical representation of this element, may be equals to this element.

See Also:

JavaSourceElement.toSource(), JavaSourceElement.getStartPosition()

getLastElement

public SourceElement getLastElement()

Description copied from class: JavaSourceElement

Finds the source element that occurs last in the source. The default implementation returns this element, which is correct for all terminal program elements, and many non terminals such as statements and prefixed operators.

Specified by:

getLastElement in interface SourceElement

Overrides:

getLastElement in class JavaSourceElement

Returns:

the last source element in the syntactical representation of this element, may be equals to this element.

See Also:

JavaSourceElement.toSource(), JavaSourceElement.getEndPosition()

getName

public final String getName()

Get name.

Specified by:

getName in interface NamedModelElement

Returns:

the string.

getFullName

public String getFullName()

Description copied from interface: ProgramModelElement

Returns the maximal expanded name including all applicable qualifiers.

Specified by:

getFullName in interface ProgramModelElement

Returns:

the full name of this program model element.

getDefaultValue

public Literal getDefaultValue()

returns the default value of the given type according to JLS 4.5.5

Specified by:

getDefaultValue in interface Type

Returns:

the default value of the given type according to JLS 4.5.5

getProgramElementName

public ProgramElementName getProgramElementName()

Get ProgramElementName.

Specified by:

getProgramElementName in interface NamedProgramElement

Returns:

the ProgramElementName.

getMembers

public ImmutableArray<MemberDeclaration> getMembers()

Get members.

Returns:

the member declaration array.

isLibraryClass

public boolean isLibraryClass()

getPackage

public Package getPackage(Services s)

TO BE IMPLEMENTED

getSupertypes

public abstract ImmutableList<KeYJavaType> getSupertypes()

returns the local declared supertypes

Specified by:

getSupertypes in interface ClassType

Returns:

the array of locally defined supertypes of this type.

getAllSupertypes

public ImmutableList<ClassType> getAllSupertypes(Services services)

TO BE IMPLEMENTED

Specified by:

getAllSupertypes in interface ClassType

Returns:

the array of all supertypes of this type in topological order.

getFields

public ImmutableList<Field> getFields(Services services)

TO BE IMPLEMENTED

Specified by:

getFields in interface ClassType

Returns:

the array of field members of this type.

getAllFields

public ImmutableList<Field> getAllFields(Services services)

[dlohner] The given parameter is obsolete with this implementation.

Specified by:

getAllFields in interface ClassType

Returns:

the array of visible field members of this type and its supertypes.

getMethods

public ImmutableList<Method> getMethods(Services services)

TO BE IMPLEMENTED

Specified by:

getMethods in interface ClassType

Returns:

the array of methods of this type.

getAllMethods

public ImmutableList<Method> getAllMethods(Services services)

TO BE IMPLEMENTED

Specified by:

getAllMethods in interface ClassType

Returns:

the array of visible methods of this type and its supertypes.

getConstructors

public ImmutableList<Constructor> getConstructors(Services services)

TO BE IMPLEMENTED

Specified by:

getConstructors in interface ClassType

Returns:

the array of constructors of this type.

getTypes

public ImmutableList<ClassType> getTypes(Services services)

TO BE IMPLEMENTED

getAllTypes

public ImmutableList<ClassType> getAllTypes(Services services)

TO BE IMPLEMENTED

Specified by:

getAllTypes in interface ClassType

Returns:

an array of class types that are members of this type or any of its supertypes.

See Also:

ClassType.getAllSupertypes(de.uka.ilkd.key.java.Services)

getTypeDeclarationCount

public int getTypeDeclarationCount()

Get the number of type declarations in this container.

Specified by:

getTypeDeclarationCount in interface TypeDeclarationContainer

Returns:

the number of type declarations.

getTypeDeclarationAt

public TypeDeclaration getTypeDeclarationAt(int index)

Specified by:

getTypeDeclarationAt in interface TypeDeclarationContainer

isFinal

public boolean isFinal()

Test whether the declaration is final.

Specified by:

isFinal in interface Member

Overrides:

isFinal in class JavaDeclaration

Returns:

true if this member is final, false otherwise.

isPrivate

public boolean isPrivate()

Test whether the declaration is private.

Specified by:

isPrivate in interface Member

Specified by:

isPrivate in interface MemberDeclaration

Overrides:

isPrivate in class JavaDeclaration

Returns:

true if this member is private, false otherwise.

isProtected

public boolean isProtected()

Test whether the declaration is protected.

Specified by:

isProtected in interface Member

Specified by:

isProtected in interface MemberDeclaration

Overrides:

isProtected in class JavaDeclaration

Returns:

true if this member is protected, false otherwise.

isPublic

public boolean isPublic()

Test whether the declaration is public.

Specified by:

isPublic in interface Member

Specified by:

isPublic in interface MemberDeclaration

Overrides:

isPublic in class JavaDeclaration

Returns:

true if this member is public, false otherwise.

isStatic

public boolean isStatic()

Test whether the declaration is static.

Specified by:

isStatic in interface Member

Specified by:

isStatic in interface MemberDeclaration

Overrides:

isStatic in class JavaDeclaration

Returns:

true if this member is static, false otherwise.

isStrictFp

public boolean isStrictFp()

Test whether the declaration is strictfp.

Specified by:

isStrictFp in interface Member

Specified by:

isStrictFp in interface MemberDeclaration

Overrides:

isStrictFp in class JavaDeclaration

Returns:

true if this member is strictfp, false otherwise.

isAbstract

public boolean isAbstract()

Test whether the declaration is abstract.

Specified by:

isAbstract in interface ClassType

Overrides:

isAbstract in class JavaDeclaration

Returns:

true if this member is abstract, false otherwise.

See Also:

ClassType.isInterface()

equals

public boolean equals(Object o)

Overrides:

equals in class JavaNonTerminalProgramElement