Package jetbrains.mps.project.structure.modules

Class ModuleReference

java.lang.Object

jetbrains.mps.project.structure.modules.ModuleReference

All Implemented Interfaces:

SModuleReference

public final class ModuleReference
extends Object
implements SModuleReference

Constructor Summary

Constructors

Constructor	Description
ModuleReference(String moduleName, SModuleId moduleId)

Method Summary

Modifier and Type	Method	Description
static boolean	differs(SModuleReference ref1, SModuleReference ref2)	Common functionality to tell if two references are identical, identical here being both id and name.
boolean	equals(Object obj)
SModuleId	getModuleId()
String	getModuleName()
int	hashCode()
static SModuleReference	parseReference(String text)
SModule	resolve(SRepository repo)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleReference

public ModuleReference(@Nullable
                       String moduleName,
                       @NotNull
                       SModuleId moduleId)

Method Detail

getModuleId

@NotNull
public SModuleId getModuleId()

Specified by:

getModuleId in interface SModuleReference

getModuleName

@Nullable
public String getModuleName()

Specified by:

getModuleName in interface SModuleReference

Returns:

null if the name is not provided the name serves as extra information here

resolve

public SModule resolve(@NotNull
                       SRepository repo)

Specified by:

resolve in interface SModuleReference

Returns:

the SModule such that SModule.getModuleReference() equals to this one. SRepository is supposed to store only one module with the given module reference

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

parseReference

public static SModuleReference parseReference(@NotNull
                                              String text)

differs

public static boolean differs(SModuleReference ref1,
                              SModuleReference ref2)

Common functionality to tell if two references are identical, identical here being both id and name. Unlike #equals(), where id takes precedence. Not specific to ModuleReference implementation, lives here as there's no better/discoverable place yet. Originates from RefUpdateUtil.

Returns:

true if either reference is null, or either references' name or id does not match