eu.cqse.check.framework.typetracker

Class TypeTrackerBase

java.lang.Object

eu.cqse.check.framework.typetracker.TypeTrackerBase

All Implemented Interfaces:

ITypeTracker

Direct Known Subclasses:

AbapTypeTracker, CLikeTypeTracker

public abstract class TypeTrackerBase
extends java.lang.Object
implements ITypeTracker

Abstract base class for type trackers.

While this base class itself does not keep any state and is thread-safe, implementing classes may introduce such behavior.

See Also:

ITypeTracker

Constructor Summary

Constructors

Constructor and Description
TypeTrackerBase(ELanguage language) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addDefaultImports(ScopedTypeLookup variableLookup) Adds default namespaces to the initial variable lookup.
ITypeResolution	createTypeResolution(java.util.List<ShallowEntity> rootEntities) Creates type information for all given shallow entities and their children.
ITypeResolution	createTypeResolution(java.util.List<ShallowEntity> rootEntities, ScopedTypeLookup variableLookup) Creates type information for all given shallow entities and their children and uses the given ScopedTypeLookup as root lookup.
protected java.util.Optional<ShallowEntity>	getAdditionalParent(ShallowEntity entity) Returns an additional shallowEntity whose type information scope should be visible for the given entity.
protected abstract java.util.Set<java.lang.String>	getSeparateScopeSubtypes() Returns all statement sub-types that need a separate scope.
protected void	initialize(java.util.List<ShallowEntity> rootEntities) Performs initialization steps for the given set of root entities.
protected boolean	needsOrderedScope(ShallowEntity entity) Returns whether the given entity needs an ordered scope.
protected void	processImport(ShallowEntity entity, ScopedTypeLookup variableLookup) Checks whether the given entity is an import of a namespace and adds the namespace to the variable lookup.

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeTrackerBase

public TypeTrackerBase(ELanguage language)

Constructor.

Method Detail

createTypeResolution

public ITypeResolution createTypeResolution(java.util.List<ShallowEntity> rootEntities)

Creates type information for all given shallow entities and their children. A type resolution is returned.

Specified by:

createTypeResolution in interface ITypeTracker

createTypeResolution

public ITypeResolution createTypeResolution(java.util.List<ShallowEntity> rootEntities,
                                            ScopedTypeLookup variableLookup)

Creates type information for all given shallow entities and their children and uses the given ScopedTypeLookup as root lookup. A type resolution is returned.

Specified by:

createTypeResolution in interface ITypeTracker

initialize

protected void initialize(java.util.List<ShallowEntity> rootEntities)

Performs initialization steps for the given set of root entities. This is intended to be overwritten by subclasses. The default implementation does nothing.

getAdditionalParent

protected java.util.Optional<ShallowEntity> getAdditionalParent(ShallowEntity entity)

Returns an additional shallowEntity whose type information scope should be visible for the given entity. This is intended to be overwritten by subclasses. The default implementation an empty optional.

addDefaultImports

protected void addDefaultImports(ScopedTypeLookup variableLookup)

Adds default namespaces to the initial variable lookup. This is intended to be overwritten by subclasses. The default implementation does nothing.

processImport

protected void processImport(ShallowEntity entity,
                             ScopedTypeLookup variableLookup)

Checks whether the given entity is an import of a namespace and adds the namespace to the variable lookup. This is intended to be overwritten by subclasses. The default implementation does nothing.

needsOrderedScope

protected boolean needsOrderedScope(ShallowEntity entity)

Returns whether the given entity needs an ordered scope. This is used e.g. for methods or statements, where variables are only accessible if they have been introduced in an entity earlier in the code. Other entities like types don't need an ordered scope, because introduced attributes are visible everywhere within the class. The default implementation returns true if the given entity's type is contained in ORDERED_ENTITY_TYPES. Subclasses may override this in order to provide language-specific behavior.

getSeparateScopeSubtypes

protected abstract java.util.Set<java.lang.String> getSeparateScopeSubtypes()

Returns all statement sub-types that need a separate scope.