org.eclipse.xtext.xbase.scoping.batch

Class AbstractSessionBasedScope

java.lang.Object

org.eclipse.xtext.scoping.impl.AbstractScope

org.eclipse.xtext.xbase.scoping.batch.AbstractSessionBasedScope

All Implemented Interfaces:

IScope

Direct Known Subclasses:

AbstractSessionBasedExecutableScope, CompositeScope, ConstructorDelegateScope, LocalVariableScope, NestedTypeLiteralScope, TypeLiteralScope

public abstract class AbstractSessionBasedScope
extends AbstractScope

Abstract scope implementation that is based on an IFeatureScopeSession. The scope can only handle feature references. It does not support case insensitivity. Clients may extend concrete subtypes and adjust the name processing or apply general filtering by overriding addToList(IEObjectDescription, List) or addToList(List, List).

Author:

Sebastian Zarnekow - Initial contribution and API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	AbstractSessionBasedScope.NameAcceptor

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	AbstractSessionBasedScope(IScope parent, IFeatureScopeSession session, XAbstractFeatureCall featureCall)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addToList(IEObjectDescription description, List<IEObjectDescription> result) Clients may override to reject certain descriptions from the result.
protected void	addToList(List<IEObjectDescription> descriptions, List<IEObjectDescription> result) Clients may override to reject certain descriptions from the result.
protected List<JvmFeature>	findAllFeaturesByName(JvmType type, String simpleName, IResolvedFeatures.Provider resolvedFeaturesProvider)
protected abstract List<IEObjectDescription>	getAllLocalElements()
Iterable<IEObjectDescription>	getElements(QualifiedName name)
protected XAbstractFeatureCall	getFeatureCall()
protected Iterable<IEObjectDescription>	getLocalElementsByEObject(org.eclipse.emf.ecore.EObject object, org.eclipse.emf.common.util.URI uri)
protected abstract List<IEObjectDescription>	getLocalElementsByName(QualifiedName name)
protected IFeatureScopeSession	getSession()
protected String	getShadowingKey(IEObjectDescription description)
protected boolean	isShadowed(IEObjectDescription fromParent)
protected void	processAsPropertyNames(QualifiedName name, AbstractSessionBasedScope.NameAcceptor acceptor) Considers the given name to be a property name.
protected void	processFeatureNames(QualifiedName name, AbstractSessionBasedScope.NameAcceptor acceptor)
protected String	toProperty(String methodName, JvmFeature feature)
protected String	toProperty(String methodName, JvmFeature feature, int getterParams, int setterParams)
protected String	tryGetAsPropertyName(String name) Returns the name as a property name, e.g. a prefix get, is or set can be used with the result of this method.

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

getAllElements, getElements, 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

AbstractSessionBasedScope

protected AbstractSessionBasedScope(IScope parent,
                         IFeatureScopeSession session,
                         XAbstractFeatureCall featureCall)

Method Detail

getAllLocalElements

protected abstract List<IEObjectDescription> getAllLocalElements()

Specified by:

getAllLocalElements in class AbstractScope

getSession

protected IFeatureScopeSession getSession()

getFeatureCall

protected XAbstractFeatureCall getFeatureCall()

processFeatureNames

protected void processFeatureNames(QualifiedName name,
                       AbstractSessionBasedScope.NameAcceptor acceptor)

findAllFeaturesByName

protected List<JvmFeature> findAllFeaturesByName(JvmType type,
                                     String simpleName,
                                     IResolvedFeatures.Provider resolvedFeaturesProvider)

processAsPropertyNames

protected void processAsPropertyNames(QualifiedName name,
                          AbstractSessionBasedScope.NameAcceptor acceptor)

Considers the given name to be a property name. If the concrete syntax of the processed feature matches a feature call or assignment, a prefix is added to the name and that one is used as a variant that should be processed.

toProperty

protected String toProperty(String methodName,
                JvmFeature feature)

toProperty

protected String toProperty(String methodName,
                JvmFeature feature,
                int getterParams,
                int setterParams)

tryGetAsPropertyName

protected String tryGetAsPropertyName(String name)

Returns the name as a property name, e.g. a prefix get, is or set can be used with the result of this method. If the given name is invalid, the result is null.

addToList

protected void addToList(IEObjectDescription description,
             List<IEObjectDescription> result)

Clients may override to reject certain descriptions from the result. All subtypes of AbstractSessionBasedScope in the framework code will delegate to this method to accumulate descriptions in a list.

See Also:

addToList(List, List)

addToList

protected void addToList(List<IEObjectDescription> descriptions,
             List<IEObjectDescription> result)

Clients may override to reject certain descriptions from the result. All subtypes of AbstractSessionBasedScope in the framework code will delegate to this method to accumulate descriptions in a list.

See Also:

addToList(IEObjectDescription, List)

getLocalElementsByName

protected abstract List<IEObjectDescription> getLocalElementsByName(QualifiedName name)

Overrides:

getLocalElementsByName in class AbstractScope

getElements

public Iterable<IEObjectDescription> getElements(QualifiedName name)

Specified by:

getElements in interface IScope

Overrides:

getElements in class AbstractScope

getLocalElementsByEObject

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

Overrides:

getLocalElementsByEObject in class AbstractScope

getShadowingKey

protected String getShadowingKey(IEObjectDescription description)

isShadowed

protected boolean isShadowed(IEObjectDescription fromParent)

Overrides:

isShadowed in class AbstractScope