fmrisc.ProgramExplorer.Semantics

Class ClassSymbol

java.lang.Object

fmrisc.ProgramExplorer.Semantics.SymbolBase

fmrisc.ProgramExplorer.Semantics.GlobalSymbolBase

fmrisc.ProgramExplorer.Semantics.ClassSymbol

All Implemented Interfaces:

GlobalSymbol, Symbol

public final class ClassSymbol
extends GlobalSymbolBase

A symbol denoting a class.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	stringClass

Constructor Summary

Constructors

Constructor and Description
ClassSymbol(PackageSymbol psymbol, Identifier name, ClassReader reader) Construct class symbol.

Method Summary

Modifier and Type	Method and Description
ParamSymbolTable<ClassMethodSymbol>	getClassMethods() Get set of class methods of this class.
java.util.Collection<ClassMethodSymbol>	getClassMethodSet() Get set of class methods of this class.
TheorySymbol	getClassTheory() Get theory symbol holding the logical type declaration for this class.
TheorySymbol	getClassTheory(ErrorStream error) Get theory symbol holding the logical type declaration for this class.
SymbolTable<ClassVariableSymbol>	getClassVariables() Get set of class values of this class.
java.util.Collection<ClassVariableSymbol>	getClassVariableSet() Get set of class values of this class.
ParamSymbols<ConstructorSymbol>	getConstructors() Get set of constructors of this class.
java.util.Collection<ConstructorSymbol>	getConstructorSet() Get set of constructors of this class.
ClassDeclaration	getDeclaration() Get the declaration of the class.
Formula	getInitFormula() Get the formula representing the initial values of the object variables.
TheorySymbol	getLocalTheory() Get theory symbol holding the local declaration for this class.
ParamSymbolTable<ObjectMethodSymbol>	getObjectMethods() Get set of object methods of this class.
java.util.Collection<ObjectMethodSymbol>	getObjectMethodSet() Get set of object methods of this class.
SymbolTable<ObjectVariableSymbol>	getObjectVariables() Get set of object values of this class.
java.util.Collection<ObjectVariableSymbol>	getObjectVariableSet() Get set of object values of this class.
PackageSymbol	getPackage() Get package of class.
java.util.Collection<Symbol>	getReferencedUnits() Get symbols of units referenced by this unit.
Source	getSource() Get source of class.
TaskFolder	getTasks() Get the folder of tasks related to this class.
TaskFolder	getTCCs() Get the type checking conditions.
ThisSymbol	getThisSymbol() Get "this" symbol for this class.
NamedType	getType() Get type for for this class.
boolean	hasErrors() Show whether class has errors.
boolean	isRead() Returns true if class has been read, i.e.
void	print(java.io.PrintWriter out) Print symbol on output stream.
boolean	read(ErrorStream error) Update declaration from reader.
void	reset() Reset symbol.
void	setClassTheory(TheorySymbol tsymbol) Set theory symbol holding the logical type declaration for this class.
void	setErrors(boolean status) Set error status.
void	setInitFormula(Formula formula) Set the formula representing the initial values of the object variables.
void	setLocalTheory(TheorySymbol tsymbol) Set theory symbol holding the local declaration for this class.

Methods inherited from class fmrisc.ProgramExplorer.Semantics.GlobalSymbolBase

getLongName

Methods inherited from class fmrisc.ProgramExplorer.Semantics.SymbolBase

getName

Methods inherited from class java.lang.Object

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

Methods inherited from interface fmrisc.ProgramExplorer.Semantics.Symbol

getName

Field Detail

stringClass

public static java.lang.String stringClass

Constructor Detail

ClassSymbol

public ClassSymbol(PackageSymbol psymbol,
                   Identifier name,
                   ClassReader reader)

Construct class symbol.

Parameters:

psymbol - the symbol of the package holding the class.

name - the name of the class

reader - the reader for getting the declaration

Method Detail

getPackage

public PackageSymbol getPackage()

Get package of class.

Returns:

the class's package

getSource

public Source getSource()

Get source of class.

Returns:

the class's source.

isRead

public boolean isRead()

Returns true if class has been read, i.e. its values are defined.

Returns:

true if class has been read.

read

public boolean read(ErrorStream error)

Update declaration from reader.

Parameters:

error - the error stream on which to print any messages.

Returns:

true if everything went fine, false if an error ocurred.

hasErrors

public boolean hasErrors()

Show whether class has errors.

Returns:

true if class has errors

setErrors

public void setErrors(boolean status)

Set error status.

Parameters:

status - true iff errors, false otherwise.

reset

public void reset()

Reset symbol.

getDeclaration

public ClassDeclaration getDeclaration()

Get the declaration of the class.

Specified by:

getDeclaration in interface Symbol

Overrides:

getDeclaration in class SymbolBase

Returns:

the declaration (may be null)

getConstructors

public ParamSymbols<ConstructorSymbol> getConstructors()

Get set of constructors of this class.

Returns:

the set of constructors.

getClassMethods

public ParamSymbolTable<ClassMethodSymbol> getClassMethods()

Get set of class methods of this class.

Returns:

the set of class methods.

getObjectMethods

public ParamSymbolTable<ObjectMethodSymbol> getObjectMethods()

Get set of object methods of this class.

Returns:

the set of object methods.

getClassVariables

public SymbolTable<ClassVariableSymbol> getClassVariables()

Get set of class values of this class.

Returns:

the set of class values.

getObjectVariables

public SymbolTable<ObjectVariableSymbol> getObjectVariables()

Get set of object values of this class.

Returns:

the set of object values.

getConstructorSet

public java.util.Collection<ConstructorSymbol> getConstructorSet()

Get set of constructors of this class. May be only called if isRead() is true.

Returns:

the set of object methods.

getClassMethodSet

public java.util.Collection<ClassMethodSymbol> getClassMethodSet()

Get set of class methods of this class. May be only called if isRead() is true.

Returns:

the set of class methods.

getObjectMethodSet

public java.util.Collection<ObjectMethodSymbol> getObjectMethodSet()

Get set of object methods of this class. May be only called if isRead() is true.

Returns:

the set of object methods.

getClassVariableSet

public java.util.Collection<ClassVariableSymbol> getClassVariableSet()

Get set of class values of this class. May be only called if isRead() is true.

Returns:

the set of class values.

getObjectVariableSet

public java.util.Collection<ObjectVariableSymbol> getObjectVariableSet()

Get set of object values of this class. May be only called if isRead() is true.

Returns:

the set of object values.

getReferencedUnits

public java.util.Collection<Symbol> getReferencedUnits()

Get symbols of units referenced by this unit.

Returns:

the collection of symbols.

setClassTheory

public void setClassTheory(TheorySymbol tsymbol)

Set theory symbol holding the logical type declaration for this class.

Parameters:

tsymbol - the theory symbol.

getClassTheory

public TheorySymbol getClassTheory()

Get theory symbol holding the logical type declaration for this class.

Returns:

the theory symbol (null, if an error occurred).

getClassTheory

public TheorySymbol getClassTheory(ErrorStream error)

Get theory symbol holding the logical type declaration for this class.

Parameters:

error - the error stream.

Returns:

the theory symbol (null, if an error occurred).

setLocalTheory

public void setLocalTheory(TheorySymbol tsymbol)

Set theory symbol holding the local declaration for this class.

Parameters:

tsymbol - the theory symbol.

getLocalTheory

public TheorySymbol getLocalTheory()

Get theory symbol holding the local declaration for this class.

Returns:

the theory symbol.

print

public void print(java.io.PrintWriter out)

Print symbol on output stream.

Parameters:

out - the output stream.

getTCCs

public TaskFolder getTCCs()

Get the type checking conditions.

Returns:

the folder holding the type checking conditions.

getTasks

public TaskFolder getTasks()

Get the folder of tasks related to this class.

Returns:

the task folder.

getThisSymbol

public ThisSymbol getThisSymbol()

Get "this" symbol for this class.

Returns:

the symbol for "this".

getType

public NamedType getType()

Get type for for this class.

Returns:

the type for this class.

setInitFormula

public void setInitFormula(Formula formula)

Set the formula representing the initial values of the object variables.

Parameters:

formula - the formula.

getInitFormula

public Formula getInitFormula()

Get the formula representing the initial values of the object variables.

Returns:

the formula (may be null).