eu.cqse.check.framework.typetracker

Class ScopedTypeLookup

java.lang.Object

eu.cqse.check.framework.typetracker.ScopedTypeLookup

public class ScopedTypeLookup
extends java.lang.Object

A scoped type lookup is an associative data structure that maps variable names to their type information. A scoped type lookup can create child lookups, that can shadow variables from the parent. Further imported namespaces are stored.

Constructor Summary

Constructors

Constructor and Description
ScopedTypeLookup() Creates a new case-sensitive lookup with no parent.
ScopedTypeLookup(boolean isCaseSensitive) Creates a new lookup with no parent and the given case-sensitivity.
ScopedTypeLookup(java.lang.String packageSeparator, boolean isCaseSensitive) Creates a new lookup with no parent and the given package separator and case-sensitivity.

Method Summary

Modifier and Type	Method and Description
void	addAddtitionalParent(ScopedTypeLookup parent) Adds an additional parent lookup.
boolean	addImportedNamespace(java.lang.String namespace) Adds an imported namespace to the scoped lookup.
boolean	containsVariable(java.lang.String variableName) Returns whether this lookup contains information about the given variable.
boolean	containsVariableWithEntity(java.lang.String variableName, ShallowEntity definitionEntity) Returns whether this lookup contains information about a variable with the given variable that was defined in the given entity.
ScopedTypeLookup	createChildScope() Creates a new lookup, with this lookup as parent.
java.util.Set<java.lang.String>	getAllVariables() Returns a set of all existing keys.
java.util.Set<java.lang.String>	getImportedNamespaces() Returns a set of all imported namespaces.
java.lang.String	getPackageSeparator()
TypedVariable	getTypeInfo(java.lang.String variableName) Returns the type information for the given key.
boolean	hasFullyQualifiedTypeName(java.lang.String variableName, java.lang.String fullyQualifiedTypeName) Returns whether the given variable has the type with the given full qualified type name.
boolean	isCaseSensitive()
boolean	isShadowingVariable(java.lang.String variableName, ShallowEntity variableEntity) Returns whether the variable with the given name is shadowing the variable that was defined by the given entity.
TypedVariable	putTypeInfo(java.lang.String variableName, TypedVariable typeInfo) Associates the given variable with the given type information in this lookup.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScopedTypeLookup

public ScopedTypeLookup()

Creates a new case-sensitive lookup with no parent.

ScopedTypeLookup

public ScopedTypeLookup(boolean isCaseSensitive)

Creates a new lookup with no parent and the given case-sensitivity.

ScopedTypeLookup

public ScopedTypeLookup(java.lang.String packageSeparator,
                        boolean isCaseSensitive)

Creates a new lookup with no parent and the given package separator and case-sensitivity.

Method Detail

addAddtitionalParent

public void addAddtitionalParent(ScopedTypeLookup parent)

Adds an additional parent lookup. This is useful e.g. when declarations and implementations are separated in the code. Ignores null and this values.

Throws:

java.lang.AssertionError - in case the parent to be added is already a descendant of the current lookup, which would cause a circular lookup dependency.

getPackageSeparator

public java.lang.String getPackageSeparator()

isCaseSensitive

public boolean isCaseSensitive()

createChildScope

public ScopedTypeLookup createChildScope()

Creates a new lookup, with this lookup as parent.

getAllVariables

public java.util.Set<java.lang.String> getAllVariables()

Returns a set of all existing keys.

putTypeInfo

public TypedVariable putTypeInfo(java.lang.String variableName,
                                 TypedVariable typeInfo)

Associates the given variable with the given type information in this lookup. Returns the old type information or null if none was set before.

getTypeInfo

public TypedVariable getTypeInfo(java.lang.String variableName)

Returns the type information for the given key. If the key is not found in this scoped lookup, the parent lookups will be searched recursively. If the key does not exist, null is returned.

addImportedNamespace

public boolean addImportedNamespace(java.lang.String namespace)

Adds an imported namespace to the scoped lookup.

getImportedNamespaces

public java.util.Set<java.lang.String> getImportedNamespaces()

Returns a set of all imported namespaces.

containsVariable

public boolean containsVariable(java.lang.String variableName)

Returns whether this lookup contains information about the given variable.

containsVariableWithEntity

public boolean containsVariableWithEntity(java.lang.String variableName,
                                          ShallowEntity definitionEntity)

Returns whether this lookup contains information about a variable with the given variable that was defined in the given entity.

isShadowingVariable

public boolean isShadowingVariable(java.lang.String variableName,
                                   ShallowEntity variableEntity)

Returns whether the variable with the given name is shadowing the variable that was defined by the given entity.

hasFullyQualifiedTypeName

public boolean hasFullyQualifiedTypeName(java.lang.String variableName,
                                         java.lang.String fullyQualifiedTypeName)

Returns whether the given variable has the type with the given full qualified type name.