Package jetbrains.mps.smodel

Class SReference

java.lang.Object

jetbrains.mps.smodel.SReference

All Implemented Interfaces:

SReference

Direct Known Subclasses:

PostponedReference, SReferenceBase

public abstract class SReference
extends Object
implements SReference

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SReference.ProblemDescription

Field Summary

Fields

Modifier and Type	Field	Description
static SReference[]	EMPTY_ARRAY
protected SNode	mySourceNode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SReference(String role, SNode sourceNode)	Deprecated.
protected	SReference(SReferenceLink role, SNode sourceNode)

Method Summary

Modifier and Type	Method	Description
static SReference	create(String role, SNode sourceNode, SModelReference targetModelReference, SNodeId targetNodeId)	Deprecated.
static SReference	create(SReferenceLink role, SNode sourceNode, SModelReference targetModelReference, SNodeId targetNodeId)
static SReference	create(SReferenceLink role, SNode sourceNode, SModelReference targetModelReference, SNodeId targetNodeId, String resolveInfo)
static SReference	create(SReferenceLink id, SNode sourceNode, SNode targetNode)
static SReference	create(SReferenceLink role, SNode sourceNode, SNodeReference pointer, String resolveInfo)
static boolean	disableLogging()
static void	enableLogging()
protected void	error(String message, boolean onlyWarn, SReference.ProblemDescription... problems)	prints error to log
SReferenceLink	getLink()	Gets the associated Link - an abstract meta-definition for the reference
String	getResolveInfo()
String	getRole()	Deprecated.
SNode	getSourceNode()	Containing node for this reference.
SNode	getTargetNode()	Resolves the target node in the containing repository.
protected abstract SNode	getTargetNode_internal()
SNodeId	getTargetNodeId()
SNodeReference	getTargetNodeReference()	Builds and returns a reference to the target node.
static SNode	getTargetNodeSilently(SReference ref)
abstract SModelReference	getTargetSModelReference()	The following two operations are defined only for references which can instantly respond to the request (e.g.
void	makeDirect()
boolean	makeIndirect()
void	setResolveInfo(String info)

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY

public static final SReference[] EMPTY_ARRAY

mySourceNode

protected final SNode mySourceNode

Constructor Detail

SReference

@Deprecated
protected SReference(String role,
                     SNode sourceNode)

Deprecated.

role must be "genuine", interned

SReference

protected SReference(SReferenceLink role,
                     SNode sourceNode)

Method Detail

create

public static SReference create(SReferenceLink id,
                                SNode sourceNode,
                                SNode targetNode)

create

public static SReference create(SReferenceLink role,
                                SNode sourceNode,
                                SModelReference targetModelReference,
                                SNodeId targetNodeId)

create

public static SReference create(SReferenceLink role,
                                SNode sourceNode,
                                SModelReference targetModelReference,
                                SNodeId targetNodeId,
                                String resolveInfo)

create

public static SReference create(SReferenceLink role,
                                SNode sourceNode,
                                SNodeReference pointer,
                                String resolveInfo)

create

@Deprecated
public static SReference create(String role,
                                SNode sourceNode,
                                SModelReference targetModelReference,
                                SNodeId targetNodeId)

Deprecated.

disableLogging

public static boolean disableLogging()

Returns:

Whether logging was really disabled by this call, i.e. it wasn't already disabled before

enableLogging

public static void enableLogging()

getTargetNodeSilently

public static SNode getTargetNodeSilently(SReference ref)

getRole

@Deprecated
public String getRole()

Deprecated.

Specified by:

getRole in interface SReference

getLink

public SReferenceLink getLink()

Description copied from interface: SReference

Gets the associated Link - an abstract meta-definition for the reference

Specified by:

getLink in interface SReference

getSourceNode

public SNode getSourceNode()

Description copied from interface: SReference

Containing node for this reference.

Specified by:

getSourceNode in interface SReference

getTargetNode

public final SNode getTargetNode()

Description copied from interface: SReference

Resolves the target node in the containing repository. This operation is not guaranteed to be fast. It may require to traverse the repository, compute types for some nodes or execute code provided by the language-designer.

Specified by:

getTargetNode in interface SReference

Returns:

the node behind the reference, or null if something is broken in the repository

getTargetNodeReference

public SNodeReference getTargetNodeReference()

Description copied from interface: SReference

Builds and returns a reference to the target node. Tries to avoid lengthy computations whenever possible. Does exactly the same as getTargetNode().getReference(), but probably faster.

Specified by:

getTargetNodeReference in interface SReference

getTargetSModelReference

@Nullable
public abstract SModelReference getTargetSModelReference()

Description copied from interface: SReference

The following two operations are defined only for references which can instantly respond to the request (e.g. they store the target model reference and/or node id as a part of the reference).

Specified by:

getTargetSModelReference in interface SReference

Returns:

target model reference (if available)

getTargetNodeId

@Nullable
public SNodeId getTargetNodeId()

Specified by:

getTargetNodeId in interface SReference

makeDirect

public void makeDirect()

makeIndirect

public boolean makeIndirect()

getResolveInfo

public String getResolveInfo()

setResolveInfo

public void setResolveInfo(String info)

getTargetNode_internal

protected abstract SNode getTargetNode_internal()

error

protected final void error(String message,
                           boolean onlyWarn,
                           SReference.ProblemDescription... problems)

prints error to log

Parameters:

onlyWarn - if true then warning must be printed out. Must be true almost always.