Package org.jetbrains.mps.openapi.model

Class SModelName

java.lang.Object

org.jetbrains.mps.openapi.model.SModelName

public final class SModelName
extends Object

Name of a model is complicated matter, we distinguish qualified/long and simple name, namespace fraction, and optional stereotype fraction of it.

[ {namespace} '.'] {simple name} [ '@' {stereotype} ]

To avoid use of utility methods scattered around the code that extract certain fractions of the model name, this object gives access to all relevant parts of the name.

Since:

3.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SModelName.SModelNameCheck	Possible SModelName check results.

Constructor Summary

Constructors

Constructor	Description
SModelName(CharSequence qualifiedName, CharSequence stereotype)
SModelName(CharSequence namespace, CharSequence simpleName, CharSequence stereotype)
SModelName(String qualifiedCompleteName)

Method Summary

Modifier and Type	Method	Description
static SModelName.SModelNameCheck	checkModelName(CharSequence longName, CharSequence stereotype)	Checks if SModelName can be constructed with such input
static SModelName.SModelNameCheck	checkModelName(CharSequence namespace, CharSequence simpleName, CharSequence stereotype)	Checks if SModelName can be constructed with such input
static SModelName.SModelNameCheck	checkModelName(String fullName)	Checks if SModelName can be constructed with such input
boolean	equals(Object obj)
String	getLongName()
String	getNamespace()
String	getShortNameWithStereotype()	Similar to getSimpleName(), just keeps stereotype part, if any
String	getSimpleName()
String	getStereotype()
String	getValue()
int	hashCode()
boolean	hasStereotype()
boolean	hasStereotype(CharSequence stereotype)
boolean	isEmpty()	Covers the case when we constructed a SModelReference with SModelId only, unaware of actual model name.
String	toString()
SModelName	withoutStereotype()	Construct a name with the identical qualified name, and without any stereotype.
SModelName	withStereotype(CharSequence newStereotype)

Methods inherited from class java.lang.Object

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

Constructor Detail

SModelName

public SModelName(@NotNull
                  String qualifiedCompleteName)

Throws:

IllegalArgumentException - if name contains illegal characters

SModelName

public SModelName(@Nullable
                  CharSequence namespace,
                  @NotNull
                  CharSequence simpleName,
                  @Nullable
                  CharSequence stereotype)

Throws:

IllegalArgumentException - if any component of a model name contains illegal characters

SModelName

public SModelName(@NotNull
                  CharSequence qualifiedName,
                  @Nullable
                  CharSequence stereotype)

Throws:

IllegalArgumentException - if any component of a model name contains illegal characters

Method Detail

isEmpty

public boolean isEmpty()

Covers the case when we constructed a SModelReference with SModelId only, unaware of actual model name.

Returns:

true iff model name is blank.

getValue

@NotNull
public String getValue()

Returns:

complete name of the model which includes optional namespace part, model name and optional stereotype, such as 'generator' or 'tests', separated by the '@' character e.g. 'jetbrains.mps.sample.generator.main@generator'

getLongName

@NotNull
public String getLongName()

Returns:

qualified model name (namespace and simple name), without stereotype

getSimpleName

@NotNull
public String getSimpleName()

Returns:

name of the model without namespace nor stereotype, empty string iff model name is blank.

getShortNameWithStereotype

@NotNull
public String getShortNameWithStereotype()

Similar to getSimpleName(), just keeps stereotype part, if any

Returns:

name of the model without namespace but with stereotype, if any.

getNamespace

@NotNull
public String getNamespace()

hasStereotype

public boolean hasStereotype()

Returns:

true iff getStereotype() would return non-empty value

hasStereotype

public boolean hasStereotype(@Nullable
                             CharSequence stereotype)

Returns:

true iff stereotype matches the argument. Name without stereotype matches both null and "" argument values.

Since:

2018.3

getStereotype

@NotNull
public String getStereotype()

withStereotype

@NotNull
public SModelName withStereotype(@Nullable
                                 CharSequence newStereotype)

Parameters:

newStereotype - stereotype for the constructed name or null to indicate that new name should not specify stereotype (identical to withoutStereotype()

Returns:

model name with qualified name identical to this model name and with a given stereotype. May return same instance if new stereotype is the same as actual.

withoutStereotype

@NotNull
public SModelName withoutStereotype()

Construct a name with the identical qualified name, and without any stereotype. May return this if there's no stereotype in the actual name (SModelName is immutable).

Returns:

model name without a stereotype, never null

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

checkModelName

@NotNull
public static SModelName.SModelNameCheck checkModelName(@Nullable
                                                        CharSequence namespace,
                                                        @NotNull
                                                        CharSequence simpleName,
                                                        @Nullable
                                                        CharSequence stereotype)

Checks if SModelName can be constructed with such input

checkModelName

@NotNull
public static SModelName.SModelNameCheck checkModelName(@NotNull
                                                        CharSequence longName,
                                                        @Nullable
                                                        CharSequence stereotype)

Checks if SModelName can be constructed with such input

checkModelName

@NotNull
public static SModelName.SModelNameCheck checkModelName(String fullName)

Checks if SModelName can be constructed with such input