org.eclipse.xtext.scoping.impl

Class AbstractScope

java.lang.Object

org.eclipse.xtext.scoping.impl.AbstractScope

All Implemented Interfaces:

IScope

Direct Known Subclasses:

ImportScope, MapBasedScope, MultimapBasedScope, SelectableBasedScope, SimpleScope

public abstract class AbstractScope
extends Object
implements IScope

Base class for custom scope implementations. It supports nesting of scopes into each other, appropriate shadowing semantics and case sensitive and insensitive lookup.

Implementors have to provide getAllLocalElements(). However, it is recommended to customize getLocalElementsByEObject(EObject, URI) and getLocalElementsByName(QualifiedName) as well.

Author:

Sven Efftinge - Initial contribution and API, Sebastian Zarnekow

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractScope.ParentIterable Lazy iterable with a reasonable AbstractScope.ParentIterable.toString() implementation that supports shadowing of parents elements by means of filtering.

Field Summary

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

NULLSCOPE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractScope(IScope parent, boolean ignoreCase) Creates a new scope with a given parent.

Method Summary

Methods

Modifier and Type	Method and Description
Iterable<IEObjectDescription>	getAllElements() Obtain all elements from the scope.
protected abstract Iterable<IEObjectDescription>	getAllLocalElements()
Iterable<IEObjectDescription>	getElements(org.eclipse.emf.ecore.EObject object) Find all descriptions that match the given instance.
Iterable<IEObjectDescription>	getElements(QualifiedName name) Find all descriptions that match the given name.
protected Iterable<IEObjectDescription>	getLocalElementsByEObject(org.eclipse.emf.ecore.EObject object, org.eclipse.emf.common.util.URI uri)
protected Iterable<IEObjectDescription>	getLocalElementsByName(QualifiedName name)
IScope	getParent()
protected Iterable<IEObjectDescription>	getParentElements(com.google.inject.Provider<Iterable<IEObjectDescription>> provider)
IEObjectDescription	getSingleElement(org.eclipse.emf.ecore.EObject object) Find the first description that matches the given instance.
IEObjectDescription	getSingleElement(QualifiedName name) Find the first description that matches the given name.
protected IEObjectDescription	getSingleLocalElementByName(QualifiedName name)
boolean	isIgnoreCase()
protected boolean	isShadowed(IEObjectDescription input) Returns true if the given description input from the parent scope is shadowed by local elements.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractScope

protected AbstractScope(IScope parent,
             boolean ignoreCase)

Creates a new scope with a given parent.

Parameters:

parent - the parent scope. May not be null. Use NULLSCOPE instead.

ignoreCase - whether name lookup and shadowing should be case insensitive or not.

Method Detail

getParent

public IScope getParent()

isIgnoreCase

public boolean isIgnoreCase()

getSingleElement

public IEObjectDescription getSingleElement(QualifiedName name)

Description copied from interface: IScope

Find the first description that matches the given name.

Specified by:

getSingleElement in interface IScope

Parameters:

name - the name of the to-be-found element. May not be null.

Returns:

the first element that matches the name. May be null.

getSingleLocalElementByName

protected IEObjectDescription getSingleLocalElementByName(QualifiedName name)

getAllElements

public Iterable<IEObjectDescription> getAllElements()

Description copied from interface: IScope

Obtain all elements from the scope. Implementors a free to throw an UnsupportedOperationException if the scope cannot be enumerated.

Specified by:

getAllElements in interface IScope

Returns:

all elements of the scope. Never null.

getElements

public Iterable<IEObjectDescription> getElements(QualifiedName name)

Description copied from interface: IScope

Find all descriptions that match the given name.

Specified by:

getElements in interface IScope

Parameters:

name - the name of the to-be-found elements. May not be null.

Returns:

all elements that match the name. Never null.

getSingleElement

public IEObjectDescription getSingleElement(org.eclipse.emf.ecore.EObject object)

Description copied from interface: IScope

Find the first description that matches the given instance.

Specified by:

getSingleElement in interface IScope

Parameters:

object - the instance whose description should be obtained. May not be null.

Returns:

the first element that matches the instance. May be null.

getElements

public Iterable<IEObjectDescription> getElements(org.eclipse.emf.ecore.EObject object)

Description copied from interface: IScope

Find all descriptions that match the given instance.

Specified by:

getElements in interface IScope

Parameters:

object - the instance whose descriptions should be obtained. May not be null.

Returns:

all elements that match the instance. Never null.

getAllLocalElements

protected abstract Iterable<IEObjectDescription> getAllLocalElements()

getLocalElementsByName

protected Iterable<IEObjectDescription> getLocalElementsByName(QualifiedName name)

getLocalElementsByEObject

protected Iterable<IEObjectDescription> getLocalElementsByEObject(org.eclipse.emf.ecore.EObject object,
                                                      org.eclipse.emf.common.util.URI uri)

getParentElements

protected Iterable<IEObjectDescription> getParentElements(com.google.inject.Provider<Iterable<IEObjectDescription>> provider)

isShadowed

protected boolean isShadowed(IEObjectDescription input)

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

Returns:

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

toString

public String toString()

Overrides:

toString in class Object