org.coode.parsers

Interface Scope

All Known Implementing Classes:

OPPLScope, OWLEntityCheckerScope

public interface Scope

Author:

Luigi Iannone

Method Summary

Modifier and Type	Method and Description
void	define(Symbol symbol) Defines a symbol inside this Scope.
void	dispose() Frees up resources used by this Scope
Set<Symbol>	getAllSymbols() Retrieves all the Symbol instances in this Scope
Set<Symbol>	getAllSymbols(Type type) Retrieves all the Symbol instances in this Scope whose tyoe is equal to the input Type.
Scope	getEnclosingScope() Retrieves the Scope enclosing this.
String	getScopeName() Retrieves the name of the scope
Set<Symbol>	match(String prefix) Retrieves the set of Symbol instances whose name starts with the input prefix.
Symbol	resolve(String name) Retrieves the symbol corresponding to the input name.

Method Detail

getScopeName

String getScopeName()

Retrieves the name of the scope

Returns:

the name of this Scope as a String

getEnclosingScope

Scope getEnclosingScope()

Retrieves the Scope enclosing this.

Returns:

a Scope that includes this Scope, or null if this Scope is the top-most (global) one.

define

void define(Symbol symbol)

Defines a symbol inside this Scope.

Parameters:

symbol - The Symbol to define. Cannot be null.

Throws:

NullPointerException - if the input is null.

resolve

Symbol resolve(String name)

Retrieves the symbol corresponding to the input name.

Parameters:

name - the name of the Symbol to retrieve. Cannot be null.

Returns:

the corresponding symbol if it has been defined previously, null otherwise.

Throws:

NullPointerException - if the input is null.

match

Set<Symbol> match(String prefix)

Retrieves the set of Symbol instances whose name starts with the input prefix.

Parameters:

prefix - The input prefix. Cannot be null.

Returns:

A Set of Symbol.

Throws:

NullPointerException - if the input is null.

getAllSymbols

Set<Symbol> getAllSymbols()

Retrieves all the Symbol instances in this Scope

Returns:

A Set of Symbol elements.

getAllSymbols

Set<Symbol> getAllSymbols(Type type)

Retrieves all the Symbol instances in this Scope whose tyoe is equal to the input Type.

Parameters:

type - . The Type of the Symbols to retrieve. Cannot be null.

Returns:

A Set of Symbol elements.

Throws:

NullPointerException - if the input is null.

dispose

void dispose()

Frees up resources used by this Scope