Package jetbrains.mps.smodel

Class SModelReference

java.lang.Object

jetbrains.mps.smodel.SModelReference

All Implemented Interfaces:

SModelReference

public final class SModelReference
extends Object
implements SModelReference

Field Summary

Fields

Modifier and Type	Field	Description
SModuleReference	myModuleReference

Constructor Summary

Constructors

Constructor	Description
SModelReference(SModuleReference module, SModelId modelId, String modelName)	Use of this constructor is discouraged, favor SModelReference(SModuleReference, SModelId, SModelName) instead
SModelReference(SModuleReference module, SModelId modelId, SModelName modelName)

Method Summary

Modifier and Type	Method	Description
static boolean	differs(SModelReference ref1, SModelReference ref2)
boolean	equals(Object o)
SModelId	getModelId()	Retrieves an identifier, which is unique within a module.
String	getModelName()	The returned name of the model may include a stereotype, such as 'generator' or 'tests', separated by the '@' character, e.g.
SModuleReference	getModuleReference()	Returns module reference when it is a part of this model reference and is available, or null otherwise.
SModelName	getName()
int	hashCode()
static SModelReference	parseReference(String s)	Deprecated. This code shall move to private method of PersistenceRegistry, which would dispatch to proper registered factories.
static Pair<Pair<SModuleId,String>,Pair<SModelId,String>>	parseReference_internal(String s)
SModel	resolve(SRepository repo)	Resolves the model from within the given repository
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

myModuleReference

@Nullable
public final SModuleReference myModuleReference

Constructor Detail

SModelReference

public SModelReference(@Nullable
                       SModuleReference module,
                       @NotNull
                       SModelId modelId,
                       @NotNull
                       String modelName)

Use of this constructor is discouraged, favor SModelReference(SModuleReference, SModelId, SModelName) instead

SModelReference

public SModelReference(@Nullable
                       SModuleReference module,
                       @NotNull
                       SModelId modelId,
                       @NotNull
                       SModelName modelName)

Method Detail

getModelId

@NotNull
public SModelId getModelId()

Description copied from interface: SModelReference

Retrieves an identifier, which is unique within a module.

Specified by:

getModelId in interface SModelReference

getName

@NotNull
public SModelName getName()

Specified by:

getName in interface SModelReference

Returns:

name of the model, may be empty but never null

getModelName

@NotNull
public String getModelName()

Description copied from interface: SModelReference

The returned name of the model may include a stereotype, such as 'generator' or 'tests', separated by the '@' character, e.g. jetbrains.mps.sample.generator.main@generator

Specified by:

getModelName in interface SModelReference

Returns:

equivalent of getName().getValue(), see SModelName.getValue()

getModuleReference

@Nullable
public SModuleReference getModuleReference()

Description copied from interface: SModelReference

Returns module reference when it is a part of this model reference and is available, or null otherwise. Globally unique SModelIds do not require module references.

Specified by:

getModuleReference in interface SModelReference

resolve

public SModel resolve(SRepository repo)

Description copied from interface: SModelReference

Resolves the model from within the given repository

Specified by:

resolve in interface SModelReference

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

parseReference

@NotNull
@Deprecated
public static SModelReference parseReference(String s)

Deprecated.

This code shall move to private method of PersistenceRegistry, which would dispatch to proper registered factories. Use PersistenceFacade.createModelReference(String) instead. Format: [ moduleID / ] modelID [ ([moduleName /] modelName ) ]

parseReference_internal

@Contract("null->null")
public static Pair<Pair<SModuleId,String>,Pair<SModelId,String>> parseReference_internal(@Nullable
                                                                                                           String s)

toString

public String toString()

Overrides:

toString in class Object

differs

public static boolean differs(SModelReference ref1,
                              SModelReference ref2)

See Also:

ModuleReference.differs(SModuleReference, SModuleReference)