org.eclipse.xtext.scoping.impl

Class MapBasedScope

java.lang.Object

org.eclipse.xtext.scoping.impl.AbstractScope

org.eclipse.xtext.scoping.impl.MapBasedScope

All Implemented Interfaces:

IScope

public class MapBasedScope
extends AbstractScope

A scope implemented using a Map used for efficient lookup of ordinary named EObjectDescriptions. This implementation assumes, that the keys of the Map correspond to the keys of the contained EObjectDescription. Additionally it assumes, that those keys are equal to description.getName().toLowerCase(). When looking up elements using AbstractScope.getElements(QualifiedName) this implementation looks up the the elements from the map, hence are much more efficient for many IEObjectDescriptions.

Author:

Sven Efftinge - Initial contribution and API, Sebastian Zarnekow

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.xtext.scoping.impl.AbstractScope

AbstractScope.ParentIterable

Field Summary

Fields inherited from interface org.eclipse.xtext.scoping.IScope

NULLSCOPE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapBasedScope(IScope parent, Map<QualifiedName,IEObjectDescription> elements, boolean ignoreCase)

Method Summary

Methods

Modifier and Type	Method and Description
static IScope	createScope(IScope parent, Collection<IEObjectDescription> descriptions)
static IScope	createScope(IScope parent, Iterable<IEObjectDescription> descriptions)
static IScope	createScope(IScope parent, Iterable<IEObjectDescription> descriptions, boolean ignoreCase)
protected Iterable<IEObjectDescription>	getAllLocalElements()
protected Iterable<IEObjectDescription>	getLocalElementsByName(QualifiedName name)
protected boolean	isShadowed(IEObjectDescription fromParent) Returns true if the given description input from the parent scope is shadowed by local elements.

Methods inherited from class org.eclipse.xtext.scoping.impl.AbstractScope

getAllElements, getElements, getElements, getLocalElementsByEObject, getParent, getParentElements, getSingleElement, getSingleElement, getSingleLocalElementByName, isIgnoreCase, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MapBasedScope

protected MapBasedScope(IScope parent,
             Map<QualifiedName,IEObjectDescription> elements,
             boolean ignoreCase)

Method Detail

createScope

public static IScope createScope(IScope parent,
                 Iterable<IEObjectDescription> descriptions,
                 boolean ignoreCase)

createScope

public static IScope createScope(IScope parent,
                 Collection<IEObjectDescription> descriptions)

Since:

2.3

createScope

public static IScope createScope(IScope parent,
                 Iterable<IEObjectDescription> descriptions)

getAllLocalElements

protected Iterable<IEObjectDescription> getAllLocalElements()

Specified by:

getAllLocalElements in class AbstractScope

getLocalElementsByName

protected Iterable<IEObjectDescription> getLocalElementsByName(QualifiedName name)

Overrides:

getLocalElementsByName in class AbstractScope

isShadowed

protected boolean isShadowed(IEObjectDescription fromParent)

Description copied from class: AbstractScope

Returns true if the given description input from the parent scope is shadowed by local elements.

Overrides:

isShadowed in class AbstractScope

Returns:

true if the given description input from the parent scope is shadowed by local elements.