Package de.monticore.types.check

Class SymTypeExpressionFactory

java.lang.Object

de.monticore.types.check.SymTypeExpressionFactory

public class SymTypeExpressionFactory
extends Object

SymTypeExpressionFactory contains static functions that create the various forms of TypeExpressions used for Sym-Types.

This factory therefore should be the only source to create SymTypeExpressions. No other source is needed. (That is ok, as the set of SymTypeExpressions is rather fixed and we do not expect many modular extensions that would be needed. Saying this, we know that potentially union types (A|B) might still be added in the future.)

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	LOG_NAME

Constructor Summary

Constructors

Constructor	Description
SymTypeExpressionFactory()

Method Summary

Modifier and Type	Method	Description
protected static SymTypeExpression	createArrayFromString(String type, IBasicSymbolsScope scope)	Deprecated, for removal: This API element is subject to removal in a future version.
static SymTypeExpression	createBottomType()
static SymTypeExpression	createFromSymbol(TypeSymbol typeSymbol)	Warning: usually not what you want, except when resolving, consider using WithinScopeBasicSymbolsResolver.resolveType(IBasicSymbolsScope, String), WithinTypeBasicSymbolsResolver.resolveType(SymTypeExpression, String, de.monticore.symboltable.modifiers.AccessModifier, java.util.function.Predicate), or other methods of this class whenever appropriate
static SymTypeOfFunction	createFunction(FunctionSymbol symbol)
static SymTypeOfFunction	createFunction(FunctionSymbol symbol, SymTypeExpression returnType, List<? extends SymTypeExpression> argumentTypes, boolean elliptic)
static SymTypeOfFunction	createFunction(SymTypeExpression returnType)
static SymTypeOfFunction	createFunction(SymTypeExpression returnType, SymTypeExpression... argumentTypes)
static SymTypeOfFunction	createFunction(SymTypeExpression returnType, List<? extends SymTypeExpression> argumentTypes)
static SymTypeOfFunction	createFunction(SymTypeExpression returnType, List<? extends SymTypeExpression> argumentTypes, boolean elliptic)
static SymTypeOfGenerics	createGenerics(TypeSymbol typeSymbol)	Deprecated, for removal: This API element is subject to removal in a future version. bad name, tends to be misused, s.a.
static SymTypeOfGenerics	createGenerics(TypeSymbol typeSymbol, SymTypeExpression... arguments)
static SymTypeOfGenerics	createGenerics(TypeSymbol typeSymbol, List<SymTypeExpression> arguments)
static SymTypeOfGenerics	createGenerics(String name, IBasicSymbolsScope enclosingScope)	Deprecated, for removal: This API element is subject to removal in a future version. hides surrogate usage, see other `createGenerics`-methods
static SymTypeOfGenerics	createGenerics(String name, IBasicSymbolsScope enclosingScope, SymTypeExpression... arguments)	Deprecated, for removal: This API element is subject to removal in a future version. hides surrogate usage, see other `createGenerics`-methods
static SymTypeOfGenerics	createGenerics(String name, IBasicSymbolsScope enclosingScope, List<SymTypeExpression> arguments)	Deprecated, for removal: This API element is subject to removal in a future version. hides surrogate usage, see other `createGenerics`-methods
static SymTypeOfGenerics	createGenericsDeclaredType(TypeSymbol typeSymbol)	Hint: this is usually(!) not what you want, s.a.
protected static SymTypeExpression	createGenericsFromString(String type, IBasicSymbolsScope scope)	Deprecated, for removal: This API element is subject to removal in a future version.
static SymTypeInferenceVariable	createInferenceVariable()	Used to create a (optionally bounded) FREE type variable, without bounds.
static SymTypeInferenceVariable	createInferenceVariable(SymTypeExpression lowerBound, SymTypeExpression upperBound)	used to create a (optionally bounded) FREE type variable.
static SymTypeInferenceVariable	createInferenceVariable(SymTypeExpression lowerBound, SymTypeExpression upperBound, String idStr)	Creates FREE type variable, BUT: You most likely do not want this method.
static SymTypeInferenceVariable	createInferenceVariable(SymTypeExpression lowerBound, SymTypeExpression upperBound, String idStr, int id)	Only used for deepcloning: You most likely do not want this method.
static SymTypeOfIntersection	createIntersection(SymTypeExpression... intersectedTypes)
static SymTypeOfIntersection	createIntersection(Collection<? extends SymTypeExpression> intersectedTypes)
static SymTypeExpression	createIntersectionOrDefault(SymTypeExpression defaultType, Collection<? extends SymTypeExpression> intersectedTypes)	a slightly normalizing createIntersection(Collection)
static SymTypeOfNumericWithSIUnit	createNumericWithSIUnit(SymTypeOfSIUnit siUnitType, SymTypeExpression numericType)
static SymTypeOfNumericWithSIUnit	createNumericWithSIUnit(List<SIUnitBasic> numerator, List<SIUnitBasic> denominator, SymTypeExpression numericType)
static SymTypeObscure	createObscureType()
static SymTypePrimitive	createPrimitive(TypeSymbol type)
static SymTypePrimitive	createPrimitive(String name)	for primitives, such as "int" (and no other kinds).
static SymTypeOfSIUnit	createSIUnit(List<SIUnitBasic> numerator, List<SIUnitBasic> denominator)
static SIUnitBasic	createSIUnitBasic(String dimension)
static SIUnitBasic	createSIUnitBasic(String dimension, int exponent)
static SIUnitBasic	createSIUnitBasic(String dimension, String prefix, int exponent)
static SymTypeOfObject	createStringType()
static SymTypeExpression	createTopType()
static SymTypeOfTuple	createTuple(SymTypeExpression... types)
static SymTypeOfTuple	createTuple(List<? extends SymTypeExpression> types)
static SymTypeArray	createTypeArray(TypeSymbol typeSymbol, int dim, SymTypeExpression argument)	Deprecated, for removal: This API element is subject to removal in a future version. arrays do not have a type symbol use createTypeArray(SymTypeExpression, int)
static SymTypeArray	createTypeArray(SymTypeExpression argument, int dim)
static SymTypeArray	createTypeArray(String name, IBasicSymbolsScope typeSymbolsScope, int dim, SymTypeExpression argument)	Deprecated, for removal: This API element is subject to removal in a future version. arrays do not have a name use createTypeArray(SymTypeExpression, int)
static SymTypeExpression	createTypeExpression(TypeSymbol typeSymbol)	Deprecated, for removal: This API element is subject to removal in a future version. misused all the time, bad name; More often than not, one does not create a SymTypeExpression based solely on a symbol, consider either using TypeCheck3.symTypeFromAST(de.monticore.types.mcbasictypes._ast.ASTMCType), WithinScopeBasicSymbolsResolver.resolveType(IBasicSymbolsScope, String), or any other method in this class.
static SymTypeExpression	createTypeExpression(String name, IBasicSymbolsScope scope)	Deprecated, for removal: This API element is subject to removal in a future version. use TypeCheck to get SymTypeExpressions from MCTypes, this method is rather incorrect/incomplete
static SymTypeOfObject	createTypeObject(TypeSymbol typeSymbol)	for ObjectTypes, as e.g.
static SymTypeOfObject	createTypeObject(String name, IBasicSymbolsScope enclosingScope)	Deprecated, for removal: This API element is subject to removal in a future version. did hide the usage of surrogate, and leads to questionable code consider using WithinScopeBasicSymbolsResolver.resolveType(IBasicSymbolsScope, String), of creating a Surrogate explicitly (only if required)
static SymTypeOfObject	createTypeObjectViaSurrogate(String name, IBasicSymbolsScope enclosingScope)	Deprecated. most current usages are wrong and have to be changed in the future! Currently considered to be removed, unless this functionality is required often enough (alternative: explicitly create a Surrogate and call createTypeObject(TypeSymbol))
static SymTypeOfNull	createTypeOfNull()	That is the pseudo-type of "null"
static SymTypeOfRegEx	createTypeRegEx(String regex)	for RegEx-types, e.g.
static SymTypeVariable	createTypeVariable(TypeSymbol typeSymbol)	Deprecated, for removal: This API element is subject to removal in a future version. ALWAYS use TypeVarSymbols to create TypeVariables
static SymTypeVariable	createTypeVariable(TypeVarSymbol typeVarSymbol)
static SymTypeVariable	createTypeVariable(String name, IBasicSymbolsScope scope)	Deprecated, for removal: This API element is subject to removal in a future version. create a symbol and use it to create a SymTypeVariable createTypeVariable(TypeVarSymbol)
static SymTypeVoid	createTypeVoid()	creates the "Void"-type, i.e.
static SymTypeOfUnion	createUnion(SymTypeExpression... unionizedTypes)
static SymTypeOfUnion	createUnion(Collection<? extends SymTypeExpression> unionizedTypes)
static SymTypeExpression	createUnionOrDefault(SymTypeExpression defaultType, Collection<? extends SymTypeExpression> unionizedTypes)	a slightly normalizing createUnion(Collection)
static SymTypeOfWildcard	createWildcard()
static SymTypeOfWildcard	createWildcard(boolean isUpper, SymTypeExpression bound)
protected static List<SymTypeExpression>	getSubGenerics(List<String> inBrackets, IBasicSymbolsScope scope)	Deprecated, for removal: This API element is subject to removal in a future version.
protected static List<String>	iterateBrackets(String type, int start)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class java.lang.Object

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

Field Details

LOG_NAME

protected static final String LOG_NAME

See Also:

• Constant Field Values

Constructor Details

SymTypeExpressionFactory

public SymTypeExpressionFactory()

Method Details

createTypeVariable

@Deprecated(forRemoval=true)
public static SymTypeVariable createTypeVariable(String name,
 IBasicSymbolsScope scope)

Deprecated, for removal: This API element is subject to removal in a future version.

create a symbol and use it to create a SymTypeVariable createTypeVariable(TypeVarSymbol)

createTypeVariable vor Variables

createTypeVariable

public static SymTypeVariable createTypeVariable(TypeVarSymbol typeVarSymbol)

createTypeVariable

@Deprecated(forRemoval=true)
public static SymTypeVariable createTypeVariable(TypeSymbol typeSymbol)

Deprecated, for removal: This API element is subject to removal in a future version.

ALWAYS use TypeVarSymbols to create TypeVariables

createInferenceVariable

public static SymTypeInferenceVariable createInferenceVariable()

Used to create a (optionally bounded) FREE type variable, without bounds. These are created internally while inferring types.

createInferenceVariable

public static SymTypeInferenceVariable createInferenceVariable(SymTypeExpression lowerBound,
 SymTypeExpression upperBound)

used to create a (optionally bounded) FREE type variable. These are created internally while inferring types.

Parameters:

lowerBound - is required to be a sub-type. For no bounds use createBottomType().

upperBound - is required to be a super-type, e.g., T extends Person & Iterable<Integer>. For no bounds use createTopType().

createInferenceVariable

public static SymTypeInferenceVariable createInferenceVariable(SymTypeExpression lowerBound,
 SymTypeExpression upperBound,
 String idStr)

Creates FREE type variable, BUT: You most likely do not want this method. Use createInferenceVariable(SymTypeExpression, SymTypeExpression).

createInferenceVariable

public static SymTypeInferenceVariable createInferenceVariable(SymTypeExpression lowerBound,
 SymTypeExpression upperBound,
 String idStr,
 int id)

Only used for deepcloning: You most likely do not want this method. Use createInferenceVariable(SymTypeExpression, SymTypeExpression).

createPrimitive

public static SymTypePrimitive createPrimitive(String name)

for primitives, such as "int" (and no other kinds). TypeInfo is not needed (as the Objects are predefined singletons)

createPrimitive

public static SymTypePrimitive createPrimitive(TypeSymbol type)

createTypeObject

public static SymTypeOfObject createTypeObject(TypeSymbol typeSymbol)

for ObjectTypes, as e.g. "Person"

createTypeObject

@Deprecated(forRemoval=true)
public static SymTypeOfObject createTypeObject(String name,
 IBasicSymbolsScope enclosingScope)

Deprecated, for removal: This API element is subject to removal in a future version.

did hide the usage of surrogate, and leads to questionable code consider using WithinScopeBasicSymbolsResolver.resolveType(IBasicSymbolsScope, String), of creating a Surrogate explicitly (only if required)

createTypeObjectViaSurrogate

@Deprecated
public static SymTypeOfObject createTypeObjectViaSurrogate(String name,
 IBasicSymbolsScope enclosingScope)

Deprecated.

most current usages are wrong and have to be changed in the future! Currently considered to be removed, unless this functionality is required often enough (alternative: explicitly create a Surrogate and call createTypeObject(TypeSymbol))

Warn: most of the time, you don't want this, as Surrogates should be avoided creates a TypeSymbolSurrogate and a SymTypeOfObject based on the surrogate

createTypeRegEx

public static SymTypeOfRegEx createTypeRegEx(String regex)

for RegEx-types, e.g. 'R"gr(a|e)y"'

createTypeVoid

public static SymTypeVoid createTypeVoid()

creates the "Void"-type, i.e. a pseudotype that represents the absence of a real type

Returns:

createObscureType

public static SymTypeObscure createObscureType()

createTypeOfNull

public static SymTypeOfNull createTypeOfNull()

That is the pseudo-type of "null"

createTypeArray

@Deprecated(forRemoval=true)
public static SymTypeArray createTypeArray(TypeSymbol typeSymbol,
 int dim,
 SymTypeExpression argument)

Deprecated, for removal: This API element is subject to removal in a future version.

arrays do not have a type symbol use createTypeArray(SymTypeExpression, int)

creates an array-Type Expression

Parameters:

typeSymbol -

dim - the dimension of the array

argument - the argument type (of the elements)

Returns:

createTypeArray

@Deprecated(forRemoval=true)
public static SymTypeArray createTypeArray(String name,
 IBasicSymbolsScope typeSymbolsScope,
 int dim,
 SymTypeExpression argument)

Deprecated, for removal: This API element is subject to removal in a future version.

arrays do not have a name use createTypeArray(SymTypeExpression, int)

createTypeArray

public static SymTypeArray createTypeArray(SymTypeExpression argument,
 int dim)

createTypeExpression

@Deprecated(forRemoval=true)
public static SymTypeExpression createTypeExpression(TypeSymbol typeSymbol)

Deprecated, for removal: This API element is subject to removal in a future version.

misused all the time, bad name; More often than not, one does not create a SymTypeExpression based solely on a symbol, consider either using TypeCheck3.symTypeFromAST(de.monticore.types.mcbasictypes._ast.ASTMCType), WithinScopeBasicSymbolsResolver.resolveType(IBasicSymbolsScope, String), or any other method in this class.

createTypeExpression

@Deprecated(forRemoval=true)
public static SymTypeExpression createTypeExpression(String name,
 IBasicSymbolsScope scope)

Deprecated, for removal: This API element is subject to removal in a future version.

use TypeCheck to get SymTypeExpressions from MCTypes, this method is rather incorrect/incomplete

creates a TypeExpression for primitives, such as "int", for "null", "void" and also for object types, such as "Person" from a given symbol Primitives don't need a type symbol, object types need both.

Parameters:

name -

scope -

createArrayFromString

@Deprecated(forRemoval=true)
protected static SymTypeExpression createArrayFromString(String type,
 IBasicSymbolsScope scope)

Deprecated, for removal: This API element is subject to removal in a future version.

createGenericsFromString

@Deprecated(forRemoval=true)
protected static SymTypeExpression createGenericsFromString(String type,
 IBasicSymbolsScope scope)

Deprecated, for removal: This API element is subject to removal in a future version.

getSubGenerics

@Deprecated(forRemoval=true)
protected static List<SymTypeExpression> getSubGenerics(List<String> inBrackets,
 IBasicSymbolsScope scope)

Deprecated, for removal: This API element is subject to removal in a future version.

recursively calls createGenericsFromString(String, IBasicSymbolsScope) (String, IBasicSymbolsScope)}. If that method for example received Map<String, List<String>> this Method should get [String, List<String>] as parameter

Parameters:

inBrackets - list of generics nested one level

iterateBrackets

@Deprecated(forRemoval=true)
protected static List<String> iterateBrackets(String type,
 int start)

Deprecated, for removal: This API element is subject to removal in a future version.

splits the type-string along commas, but only on such that are on the first depth of generics

Parameters:

type - type-string, like Map<Double, LinkedHashMap<String, Integer>>

start - first occurrence of an opening generic

Returns:

all first sub-generics as a list, like [Double; LinkedHashMap<String, Integer>]

createGenericsDeclaredType

public static SymTypeOfGenerics createGenericsDeclaredType(TypeSymbol typeSymbol)

Hint: this is usually(!) not what you want, s.a. createGenerics(TypeSymbol, List)

Returns:

the declared type, e.g., Map<K,V>, with K and V being (bound) TypeVariables

createGenerics

@Deprecated(forRemoval=true)
public static SymTypeOfGenerics createGenerics(TypeSymbol typeSymbol)

Deprecated, for removal: This API element is subject to removal in a future version.

bad name, tends to be misused, s.a. createGenericsDeclaredType(TypeSymbol)

createGenerics

public static SymTypeOfGenerics createGenerics(TypeSymbol typeSymbol,
 List<SymTypeExpression> arguments)

createGenerics

public static SymTypeOfGenerics createGenerics(TypeSymbol typeSymbol,
 SymTypeExpression... arguments)

createGenerics

@Deprecated(forRemoval=true)
public static SymTypeOfGenerics createGenerics(String name,
 IBasicSymbolsScope enclosingScope)

Deprecated, for removal: This API element is subject to removal in a future version.

hides surrogate usage, see other `createGenerics`-methods

createGenerics: is created using the enclosing Scope to ask for the appropriate symbol.

createGenerics

@Deprecated(forRemoval=true)
public static SymTypeOfGenerics createGenerics(String name,
 IBasicSymbolsScope enclosingScope,
 List<SymTypeExpression> arguments)

Deprecated, for removal: This API element is subject to removal in a future version.

hides surrogate usage, see other `createGenerics`-methods

createGenerics

@Deprecated(forRemoval=true)
public static SymTypeOfGenerics createGenerics(String name,
 IBasicSymbolsScope enclosingScope,
 SymTypeExpression... arguments)

Deprecated, for removal: This API element is subject to removal in a future version.

hides surrogate usage, see other `createGenerics`-methods

createFromSymbol

public static SymTypeExpression createFromSymbol(TypeSymbol typeSymbol)

Warning: usually not what you want, except when resolving, consider using WithinScopeBasicSymbolsResolver.resolveType(IBasicSymbolsScope, String), WithinTypeBasicSymbolsResolver.resolveType(SymTypeExpression, String, de.monticore.symboltable.modifiers.AccessModifier, java.util.function.Predicate), or other methods of this class whenever appropriate

createWildcard

public static SymTypeOfWildcard createWildcard(boolean isUpper,
 SymTypeExpression bound)

createWildcard

public static SymTypeOfWildcard createWildcard()

createFunction

public static SymTypeOfFunction createFunction(FunctionSymbol symbol)

createFunction

public static SymTypeOfFunction createFunction(SymTypeExpression returnType)

createFunction

public static SymTypeOfFunction createFunction(SymTypeExpression returnType,
 List<? extends SymTypeExpression> argumentTypes)

createFunction

public static SymTypeOfFunction createFunction(SymTypeExpression returnType,
 SymTypeExpression... argumentTypes)

createFunction

public static SymTypeOfFunction createFunction(SymTypeExpression returnType,
 List<? extends SymTypeExpression> argumentTypes,
 boolean elliptic)

createFunction

public static SymTypeOfFunction createFunction(FunctionSymbol symbol,
 SymTypeExpression returnType,
 List<? extends SymTypeExpression> argumentTypes,
 boolean elliptic)

createSIUnitBasic

public static SIUnitBasic createSIUnitBasic(String dimension)

createSIUnitBasic

public static SIUnitBasic createSIUnitBasic(String dimension,
 int exponent)

createSIUnitBasic

public static SIUnitBasic createSIUnitBasic(String dimension,
 String prefix,
 int exponent)

createSIUnit

public static SymTypeOfSIUnit createSIUnit(List<SIUnitBasic> numerator,
 List<SIUnitBasic> denominator)

createNumericWithSIUnit

public static SymTypeOfNumericWithSIUnit createNumericWithSIUnit(List<SIUnitBasic> numerator,
 List<SIUnitBasic> denominator,
 SymTypeExpression numericType)

createNumericWithSIUnit

public static SymTypeOfNumericWithSIUnit createNumericWithSIUnit(SymTypeOfSIUnit siUnitType,
 SymTypeExpression numericType)

createTuple

public static SymTypeOfTuple createTuple(List<? extends SymTypeExpression> types)

createTuple

public static SymTypeOfTuple createTuple(SymTypeExpression... types)

createUnion

public static SymTypeOfUnion createUnion(Collection<? extends SymTypeExpression> unionizedTypes)

createUnion

public static SymTypeOfUnion createUnion(SymTypeExpression... unionizedTypes)

createUnionOrDefault

public static SymTypeExpression createUnionOrDefault(SymTypeExpression defaultType,
 Collection<? extends SymTypeExpression> unionizedTypes)

a slightly normalizing createUnion(Collection)

createIntersection

public static SymTypeOfIntersection createIntersection(Collection<? extends SymTypeExpression> intersectedTypes)

createIntersection

public static SymTypeOfIntersection createIntersection(SymTypeExpression... intersectedTypes)

createIntersectionOrDefault

public static SymTypeExpression createIntersectionOrDefault(SymTypeExpression defaultType,
 Collection<? extends SymTypeExpression> intersectedTypes)

a slightly normalizing createIntersection(Collection)

createTopType

public static SymTypeExpression createTopType()

Returns:

a type which is the superType of ALL other types, NO further guarantees are made. Note, this is not the case for, e.g., Java's Object class as it is not a superType of primitives This is used internally in the TypeCheck.

createBottomType

public static SymTypeExpression createBottomType()

Returns:

a type which is the subType of ALL other types, NO further guarantees are made. Note, this is not the case for, e.g., Java's null type as it is not a subType of primitives This is used internally in the TypeCheck.

createStringType

public static SymTypeOfObject createStringType()