org.eclipse.xtext.xbase.scoping.batch

Class AbstractNestedFeatureScopeSession

java.lang.Object

org.eclipse.xtext.xbase.scoping.batch.AbstractFeatureScopeSession

org.eclipse.xtext.xbase.scoping.batch.AbstractNestedFeatureScopeSession

All Implemented Interfaces:

IFeatureScopeSession, IVisibilityHelper

Direct Known Subclasses:

ConstructorFeatureScopeSession, FeatureScopeSessionWithCapturedLocalElements, FeatureScopeSessionWithContext, FeatureScopeSessionWithDynamicExtensions, FeatureScopeSessionWithLocalElements, FeatureScopeSessionWithNamedStaticTypes, FeatureScopeSessionWithNestedTypes, FeatureScopeSessionWithoutLocalElements, FeatureScopeSessionWithStaticTypes, InstanceFeatureScopeSession

public abstract class AbstractNestedFeatureScopeSession
extends AbstractFeatureScopeSession

An abstract nested feature scope session. Delegates all queries to its parent.

Author:

Sebastian Zarnekow - Initial contribution and API TODO toString TODO more JavaDoc

Field Summary

Fields inherited from interface org.eclipse.xtext.xbase.typesystem.util.IVisibilityHelper

ALL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractNestedFeatureScopeSession(AbstractFeatureScopeSession parent)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addExtensionProviders(List<ExpressionBucket> result)
protected void	addLocalElements(List<IEObjectDescription> result)
protected ConstructorScopes	getConstructorScopes()
protected IScopeProvider	getDefaultScopeProvider()
List<JvmDeclaredType>	getEnclosingTypes() Returns a list of enclosing types that provide an instance in the current context.
List<ExpressionBucket>	getExtensionProviders() All extension providers as expression buckets.
protected FeatureScopes	getFeatureScopes()
protected int	getId() A simple means to identify the session.
IEObjectDescription	getLocalElement(QualifiedName name) Find a local element with the given qualified name.
List<JvmDeclaredType>	getNestedTypeDeclarators() Returns enclosing types that declare available nested types.
IFeatureScopeSession	getNextCaptureLayer() Returns the next layer of the captured scopes.
protected AbstractFeatureScopeSession	getParent()
protected IResolvedFeatures.Provider	getResolvedFeaturesProvider()
List<TypeBucket>	getStaticallyImportedExtensionTypes() All statically imported extension types as type buckets.
List<TypeBucket>	getStaticallyImportedTypes() All statically imported types as type buckets.
protected TypeScopes	getTypeScopes()
boolean	isConstructorContext() Returns true if the current expression is used in a constructor body.
boolean	isInstanceContext() Returns true if this can be validly resolved in the current scope.
boolean	isVisible(JvmMember member) Returns true if the member is visible according to the JvmVisibility and the local context.
boolean	isVisible(JvmMember member, LightweightTypeReference receiverType, JvmIdentifiableElement receiverFeature) Returns true if the member is visible according to the JvmVisibility and the local context when invoked on the given receiver feature which resolves to the given type.

Methods inherited from class org.eclipse.xtext.xbase.scoping.batch.AbstractFeatureScopeSession

addImports, addLocalElement, addLocalElements, addNestedTypesToScope, addToExtensionScope, addTypesToStaticScope, captureLocalElements, createConstructorScope, createFeatureCallScope, createTypeScope, dropLocalElements, getLocalElements, getScope, toConstructorContext, toInstanceContext, tryCreateNestedSessionWithVisibilityContext

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNestedFeatureScopeSession

protected AbstractNestedFeatureScopeSession(AbstractFeatureScopeSession parent)

Method Detail

getDefaultScopeProvider

protected IScopeProvider getDefaultScopeProvider()

Specified by:

getDefaultScopeProvider in class AbstractFeatureScopeSession

getFeatureScopes

protected FeatureScopes getFeatureScopes()

Specified by:

getFeatureScopes in class AbstractFeatureScopeSession

getResolvedFeaturesProvider

protected IResolvedFeatures.Provider getResolvedFeaturesProvider()

Specified by:

getResolvedFeaturesProvider in class AbstractFeatureScopeSession

getConstructorScopes

protected ConstructorScopes getConstructorScopes()

Specified by:

getConstructorScopes in class AbstractFeatureScopeSession

getTypeScopes

protected TypeScopes getTypeScopes()

Specified by:

getTypeScopes in class AbstractFeatureScopeSession

getParent

protected AbstractFeatureScopeSession getParent()

getNextCaptureLayer

public IFeatureScopeSession getNextCaptureLayer()

Description copied from interface: IFeatureScopeSession

Returns the next layer of the captured scopes.

Specified by:

getNextCaptureLayer in interface IFeatureScopeSession

Overrides:

getNextCaptureLayer in class AbstractFeatureScopeSession

getEnclosingTypes

public List<JvmDeclaredType> getEnclosingTypes()

Description copied from interface: IFeatureScopeSession

Returns a list of enclosing types that provide an instance in the current context. The first element in the list is the innermost type.

Specified by:

getEnclosingTypes in interface IFeatureScopeSession

Overrides:

getEnclosingTypes in class AbstractFeatureScopeSession

getNestedTypeDeclarators

public List<JvmDeclaredType> getNestedTypeDeclarators()

Description copied from interface: IFeatureScopeSession

Returns enclosing types that declare available nested types. The first element in the list is the innermost type.

Specified by:

getNestedTypeDeclarators in interface IFeatureScopeSession

Overrides:

getNestedTypeDeclarators in class AbstractFeatureScopeSession

getLocalElement

public IEObjectDescription getLocalElement(QualifiedName name)

Description copied from interface: IFeatureScopeSession

Find a local element with the given qualified name.

Returns:

the known element or null.

addLocalElements

protected void addLocalElements(List<IEObjectDescription> result)

Overrides:

addLocalElements in class AbstractFeatureScopeSession

Parameters:

result - the list of all local elements. Shadowing semantics do not have to be applied.

getStaticallyImportedTypes

public List<TypeBucket> getStaticallyImportedTypes()

Description copied from interface: IFeatureScopeSession

All statically imported types as type buckets. The list has usually two elements:

1. The implicitly imported types as a single bucket.
2. The explicitly imported types as a single bucket.

Scenarios with more than two buckets are especially nested structures with multiple import sections or ordered imports.

Specified by:

getStaticallyImportedTypes in interface IFeatureScopeSession

Overrides:

getStaticallyImportedTypes in class AbstractFeatureScopeSession

getStaticallyImportedExtensionTypes

public List<TypeBucket> getStaticallyImportedExtensionTypes()

Description copied from interface: IFeatureScopeSession

All statically imported extension types as type buckets. The list has usually two elements:

1. The implicitly available extensions as a single bucket.
2. The explicitly imported extensions as a single bucket.

Scenarios with more than two buckets are especially nested structures with multiple import sections or ordered imports.

Specified by:

getStaticallyImportedExtensionTypes in interface IFeatureScopeSession

Overrides:

getStaticallyImportedExtensionTypes in class AbstractFeatureScopeSession

getExtensionProviders

public List<ExpressionBucket> getExtensionProviders()

Description copied from interface: IFeatureScopeSession

All extension providers as expression buckets.

Specified by:

getExtensionProviders in interface IFeatureScopeSession

Overrides:

getExtensionProviders in class AbstractFeatureScopeSession

Returns:

the list of extension providers.

isInstanceContext

public boolean isInstanceContext()

Description copied from interface: IFeatureScopeSession

Returns true if this can be validly resolved in the current scope.

See Also:

IFeatureScopeSession.toInstanceContext()

isConstructorContext

public boolean isConstructorContext()

Description copied from interface: IFeatureScopeSession

Returns true if the current expression is used in a constructor body.

See Also:

IFeatureScopeSession.toConstructorContext()

addExtensionProviders

protected void addExtensionProviders(List<ExpressionBucket> result)

Overrides:

addExtensionProviders in class AbstractFeatureScopeSession

Parameters:

result - an aggregating parameter that accepts the extension providers.

getId

protected int getId()

Description copied from class: AbstractFeatureScopeSession

A simple means to identify the session.

Specified by:

getId in class AbstractFeatureScopeSession

isVisible

public boolean isVisible(JvmMember member)

Description copied from interface: IVisibilityHelper

Returns true if the member is visible according to the JvmVisibility and the local context.

Parameters:

member - the member that shall be accessed.

Returns:

true if the feature can be accessed.

isVisible

public boolean isVisible(JvmMember member,
                LightweightTypeReference receiverType,
                JvmIdentifiableElement receiverFeature)

Description copied from interface: IFeatureScopeSession

Returns true if the member is visible according to the JvmVisibility and the local context when invoked on the given receiver feature which resolves to the given type.

Parameters:

member - the member that shall be accessed.

receiverType - the type of the receiver. May be unknown.

receiverFeature - the links the receiver of the feature call to the given member. May be unknown.

Returns:

true if the feature can be accessed.