fmrisc.ProgramExplorer.Semantics

Class PackageSymbol

java.lang.Object

fmrisc.ProgramExplorer.Semantics.SymbolBase

fmrisc.ProgramExplorer.Semantics.GlobalSymbolBase

fmrisc.ProgramExplorer.Semantics.PackageSymbol

All Implemented Interfaces:

GlobalSymbol, Symbol

public final class PackageSymbol
extends GlobalSymbolBase

A symbol denoting a value.

Constructor Summary

Constructors

Constructor and Description
PackageSymbol(Identifier name, ErrorStream error, java.io.File dir) Construct symbol for top-level package.
PackageSymbol(PackageSymbol parent, Identifier name, ErrorStream error) Construct symbol for subpackage of another package.

Method Summary

Modifier and Type	Method and Description
SymbolTable<ClassSymbol>	getClasses() Get set of classes held by package.
java.util.Collection<ClassSymbol>	getClassSet() Get set of classes held by package as collection.
LogicTypeTable	getLogicTypeTable() Get logic type table of package.
PackageSymbol	getPackage(Name name) Return symbol for package denoted by name in current package; an error message is printed if the lookup fails.
PackageSymbol	getPackage(Name name, boolean verbose) Return symbol for package denoted by name in current package.
SymbolTable<PackageSymbol>	getPackages() Get set of packages held by package.
java.util.Collection<PackageSymbol>	getPackageSet() Get set of packages held by package as collection.
PackageSymbol	getParent() Get parent package.
TaskFolder	getTasks() Get the folder of tasks related to this package.
SymbolTable<TheorySymbol>	getTheories() Get set of theories held by package.
java.util.Collection<TheorySymbol>	getTheorySet() Get set of theories held by package as collection.
PackageSymbol	getTopPackage() Get top-level package of package
TypeTable	getTypeTable() Get type table of package.
TypeTranslator	getTypeTranslator() Get type translator of package.
void	print(java.io.PrintWriter out) Print symbol on output stream.
void	setDirectory(java.io.File dir) Set directory associated to package.

Methods inherited from class fmrisc.ProgramExplorer.Semantics.GlobalSymbolBase

getLongName

Methods inherited from class fmrisc.ProgramExplorer.Semantics.SymbolBase

getDeclaration, 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

getDeclaration, getName

Constructor Detail

PackageSymbol

public PackageSymbol(Identifier name,
                     ErrorStream error,
                     java.io.File dir)

Construct symbol for top-level package.

Parameters:

name - the name of the package

error - the stream for printing error messages

dir - directory for writing information

PackageSymbol

public PackageSymbol(PackageSymbol parent,
                     Identifier name,
                     ErrorStream error)

Construct symbol for subpackage of another package.

Parameters:

parent - the parent package.

name - the short name of the package.

error - the stream for printing error messages

Method Detail

getParent

public PackageSymbol getParent()

Get parent package.

Returns:

parent package (null for top-level package).

getTopPackage

public PackageSymbol getTopPackage()

Get top-level package of package

Returns:

the top-level package for this package

getTypeTable

public TypeTable getTypeTable()

Get type table of package.

Returns:

the package's type table.

getLogicTypeTable

public LogicTypeTable getLogicTypeTable()

Get logic type table of package.

Returns:

the package's logic type table.

getTypeTranslator

public TypeTranslator getTypeTranslator()

Get type translator of package.

Returns:

the package's type translator

getPackages

public SymbolTable<PackageSymbol> getPackages()

Get set of packages held by package.

Returns:

the set of packages.

getPackageSet

public java.util.Collection<PackageSymbol> getPackageSet()

Get set of packages held by package as collection.

Returns:

the set of packages.

getClasses

public SymbolTable<ClassSymbol> getClasses()

Get set of classes held by package.

Returns:

the set of classes.

getClassSet

public java.util.Collection<ClassSymbol> getClassSet()

Get set of classes held by package as collection.

Returns:

the set of classes.

getTheories

public SymbolTable<TheorySymbol> getTheories()

Get set of theories held by package.

Returns:

the set of theories.

getTheorySet

public java.util.Collection<TheorySymbol> getTheorySet()

Get set of theories held by package as collection.

Returns:

the set of theories.

setDirectory

public void setDirectory(java.io.File dir)

Set directory associated to package.

Parameters:

dir - the directory.

print

public void print(java.io.PrintWriter out)

Print symbol on output stream.

Parameters:

out - the output stream.

getPackage

public PackageSymbol getPackage(Name name)

Return symbol for package denoted by name in current package; an error message is printed if the lookup fails.

Parameters:

name - a name which should denote a package.

Returns:

the symbol or null if the name could not be looked up

getPackage

public PackageSymbol getPackage(Name name,
                                boolean verbose)

Return symbol for package denoted by name in current package.

Parameters:

name - a name which should denote a package.

verbose - true if an error message is printed if the lookup fails.

Returns:

the symbol or null if the name could not be looked up

getTasks

public TaskFolder getTasks()

Get the folder of tasks related to this package.

Returns:

the task folder.