de.uka.ilkd.key.java.declaration

Class EnumClassDeclaration

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.ClassDeclaration

de.uka.ilkd.key.java.declaration.EnumClassDeclaration

All Implemented Interfaces:

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

public class EnumClassDeclaration
extends ClassDeclaration

This class is used for wrapping an enum into a standard class type.

In addition the programvariables that represent enum constants are memorized. Thus this class is able to have queries on the enum constants.

Since:

2006-12-10

Author:

mulbrich

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<IProgramVariable>	constants store the program variables which represent the enum constants

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

extending, implementing, isAnonymousClass, isInnerClass, isLocalClass

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
EnumClassDeclaration(ExtList children, ProgramElementName fullName, boolean isLibrary, java.util.List<EnumConstantDeclaration> enumConstantDeclarations) create a new EnumClassDeclaration that describes an enum defintion.

Method Summary

Modifier and Type	Method and Description
private IProgramVariable	findAttr(java.lang.String fieldName)
int	getNumberOfConstants() get the number of defined enum constants in this type.
static int	indexOf(ProgramVariable attribute)
static boolean	isEnumConstant(IProgramVariable attribute) check whether a PV is an enum constant of any enum type.
private boolean	isLocalEnumConstant(IProgramVariable pv)
private int	localIndexOf(ProgramVariable pv) get the index of the program variable amongst the enumconstants of THIS enum.

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

getChildAt, getChildCount, getExtendedTypes, getImplementedTypes, getSupertypes, isAnonymousClass, isInnerClass, isInterface, isLocalClass, isStrictFp, isTransient, isVolatile, prettyPrint, visit

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, isAbstract, isFinal, isLibraryClass, isPrivate, isProtected, isPublic, isStatic

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

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

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.ProgramElement

getComments, match

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

equalsModRenaming, getEndPosition, getFirstElement, getFirstElementIncludingBlocks, getLastElement, getPositionInfo, getRelativePosition, getStartPosition

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

getModifiers

Field Detail

constants

private java.util.List<IProgramVariable> constants

store the program variables which represent the enum constants

Constructor Detail

EnumClassDeclaration

public EnumClassDeclaration(ExtList children,
                            ProgramElementName fullName,
                            boolean isLibrary,
                            java.util.List<EnumConstantDeclaration> enumConstantDeclarations)

create a new EnumClassDeclaration that describes an enum defintion. It merely wraps a ClassDeclaration but has memory about which fields have been declared as enum constants.

Parameters:

children - children in the ast (members)

fullName - of the class/enum

isLibrary - see class constructor

enumConstantDeclarations - the declarations for the enum constants

Method Detail

findAttr

private IProgramVariable findAttr(java.lang.String fieldName)

isLocalEnumConstant

private boolean isLocalEnumConstant(IProgramVariable pv)

localIndexOf

private int localIndexOf(ProgramVariable pv)

get the index of the program variable amongst the enumconstants of THIS enum.

Parameters:

pv - PV to look up

Returns:

-1 if not found, otherwise the 0-based index.

getNumberOfConstants

public int getNumberOfConstants()

get the number of defined enum constants in this type.

Returns:

the number of defined enum constants in this type

isEnumConstant

public static boolean isEnumConstant(IProgramVariable attribute)

check whether a PV is an enum constant of any enum type.

Parameters:

attribute - ProgramVariable to check.

Returns:

true iff attribute is an enum constant.

indexOf

public static int indexOf(ProgramVariable attribute)