Package jetbrains.mps.scope

Class ListScope

java.lang.Object

jetbrains.mps.scope.Scope

jetbrains.mps.scope.ListScope

public abstract class ListScope
extends Scope

Constructor Summary

Constructors

Constructor	Description
ListScope(Iterable<SNode> elements)

Method Summary

Modifier and Type	Method	Description
static ListScope	forNamedElements(Iterable<SNode> elements)
static ListScope	forResolvableElements(Iterable<SNode> elements)	Scope of elements that can be resolved by either IResolveInfo#resolveInfo, INamedConcept#name or BC#getPresentation() Introduced as a counterpart to returning list of nodes in ConstraintFunction_ReferentSearchScope_Factory
Iterable<SNode>	getAvailableElements(String prefix)	Returns all available elements in the scope.
abstract String	getName(SNode child)
String	getReferenceText(SNode contextNode, SNode node)	Creates textual reference for scope element.
SNode	resolve(SNode contextNode, String refText)	Resolves element by reference text.

Methods inherited from class jetbrains.mps.scope.Scope

contains, getScope, getScope, parent

Methods inherited from class java.lang.Object

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

Constructor Detail

ListScope

public ListScope(Iterable<SNode> elements)

Method Detail

resolve

public SNode resolve(SNode contextNode,
                     @NotNull
                     String refText)

Description copied from class: Scope

Resolves element by reference text. Invariant: getReferenceText(contextNode, resolve(contextNode, refText)) == refText

Specified by:

resolve in class Scope

Parameters:

contextNode - source node for the reference, or its nearest parent node (if source node is unavailable)

refText - reference text

Returns:

resolved element when reference text unambiguously identifies element, null otherwise

getAvailableElements

public Iterable<SNode> getAvailableElements(@Nullable
                                            String prefix)

Description copied from class: Scope

Returns all available elements in the scope.

Specified by:

getAvailableElements in class Scope

Parameters:

prefix - (if not null) filters out elements whose reference text doesn't start with prefix

Returns:

list of nodes in the scope

getReferenceText

public String getReferenceText(SNode contextNode,
                               SNode node)

Description copied from class: Scope

Creates textual reference for scope element. If element has no textual representation for the reference, returns null. Invariant: resolve(contextNode, getReferenceText(contextNode, node)) == node

Specified by:

getReferenceText in class Scope

Parameters:

contextNode - source node for the reference, or its nearest parent node (if source node is unavailable)

node - element from the current scope (contains(node) == true)

Returns:

reference text for the node element in the current scope

getName

public abstract String getName(SNode child)

forNamedElements

public static ListScope forNamedElements(Iterable<SNode> elements)

forResolvableElements

public static ListScope forResolvableElements(Iterable<SNode> elements)

Scope of elements that can be resolved by either IResolveInfo#resolveInfo, INamedConcept#name or BC#getPresentation() Introduced as a counterpart to returning list of nodes in ConstraintFunction_ReferentSearchScope_Factory