Package com.google.javascript.rhino.jstype

Class KnownSymbolType

java.lang.Object

com.google.javascript.rhino.jstype.JSType

com.google.javascript.rhino.jstype.SymbolType

com.google.javascript.rhino.jstype.KnownSymbolType

public final class KnownSymbolType
extends SymbolType

A concrete instance of a JavaScript symbol.

This includes all "well-known" symbols in the spec - Symbol.iterator, Symbol.asyncIterator, etc.

This is analogous to the EnumElementType class - each KnownSymbolType is a subtype of the general symbol type, but unique KnownSymbolTypes are not subtypes of one another.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.javascript.rhino.jstype.JSType

JSType.HasPropertyKind, JSType.Nullability, JSType.SubtypingMode, JSType.TypePair, JSType.WithSourceRef

Field Summary

Fields inherited from class com.google.javascript.rhino.jstype.JSType

templateTypeMap

Constructor Summary

Constructors

Constructor	Description
KnownSymbolType(JSTypeRegistry registry, String name)

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()	Returns a user meaningful label for the JSType instance.
JSType.HasPropertyKind	getPropertyKind(Property.Key propertyName, boolean autobox)	Checks whether the property is present on the object.
boolean	hasDisplayName()
boolean	isKnownSymbolValueType()
KnownSymbolType	toMaybeKnownSymbolType()

Methods inherited from class com.google.javascript.rhino.jstype.SymbolType

autoboxesTo, getPossibleToBooleanOutcomes, isSymbolValueType, matchesNumberContext, matchesObjectContext, matchesStringContext, matchesSymbolContext, testForEquality, visit

Methods inherited from class com.google.javascript.rhino.jstype.JSType

areSimilar, assertFunctionType, assertObjectType, autobox, canBeCalled, canCastTo, canTestForEqualityWith, canTestForShallowEqualityWith, collapseUnion, containsReferenceAncestor, dereference, differsFrom, equals, findPropertyType, findPropertyType, findPropertyTypeWithoutConsideringTemplateTypes, getEnumeratedTypeOfEnumElement, getGreatestSubtype, getJSDocInfo, getLeastSupertype, getPropertyKind, getPropertyKind, getPropertyKind, getRestrictedTypeGivenOutcome, getTemplateParamCount, getTemplateTypeMap, getTypeParameters, getTypesUnderEquality, getTypesUnderInequality, getTypesUnderShallowEquality, getTypesUnderShallowInequality, getUnionMembers, hasAnyTemplateTypes, hashCode, hasProperty, hasProperty, isAllType, isArrayType, isBigIntObjectType, isBigIntOrNumber, isBigIntValueType, isBooleanObjectType, isBooleanValueType, isBoxableScalar, isCheckedUnknownType, isConstructor, isDateType, isDict, isEmptyType, isEnumElementType, isEnumType, isExplicitlyVoidable, isFunctionPrototypeType, isFunctionType, isGlobalThisType, isInstanceType, isInterface, isLiteralObject, isNamedType, isNativeObjectType, isNominalConstructorOrInterface, isNominalType, isNoObjectType, isNoResolvedType, isNoType, isNullable, isNullType, isNumber, isNumberObjectType, isNumberValueType, isObject, isObjectType, isOnlyBigInt, isOrdinaryFunction, isRawTypeOfTemplatizedType, isReadonlyArrayType, isRecordType, isRegexpType, isResolved, isSomeUnknownType, isString, isStringObjectType, isStringValueType, isStruct, isStructuralInterface, isStructuralType, isSubtype, isSubtype, isSubtypeOf, isSubtypeOf, isSubtypeWithoutStructuralTyping, isSuccessfullyResolved, isSymbol, isSymbolObjectType, isTemplateType, isTemplatizedType, isUnionType, isUnknownType, isUnsuccessfullyResolved, isVoidable, isVoidType, loosenTypecheckingDueToForwardReferencedSupertype, matchConstraint, mergeSupertypeTemplateTypes, resolve, restrictByNotNull, restrictByNotNullOrUndefined, restrictByNotUndefined, setValidator, toAnnotationString, toMaybeEnumElementType, toMaybeEnumType, toMaybeFunctionType, toMaybeFunctionType, toMaybeNamedType, toMaybeObjectType, toMaybeRecordType, toMaybeTemplateType, toMaybeTemplatizedType, toMaybeUnionType, toObjectType, toString

Methods inherited from class java.lang.Object

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

Constructor Details

KnownSymbolType

public KnownSymbolType(JSTypeRegistry registry,
 String name)

Method Details

getDisplayName

public String getDisplayName()

Description copied from class: JSType

Returns a user meaningful label for the JSType instance. For example, Functions and Enums will return their declaration name (if they have one). Some types will not have a meaningful display name. Calls to hasDisplayName() will return true IFF getDisplayName() will return null or a zero length string.

Overrides:

getDisplayName in class SymbolType

Returns:

the display name of the type, or null if one is not available

isKnownSymbolValueType

public boolean isKnownSymbolValueType()

Overrides:

isKnownSymbolValueType in class JSType

toMaybeKnownSymbolType

public KnownSymbolType toMaybeKnownSymbolType()

Overrides:

toMaybeKnownSymbolType in class JSType

hasDisplayName

public boolean hasDisplayName()

Overrides:

hasDisplayName in class JSType

Returns:

true if the JSType has a user meaningful label.

getPropertyKind

public JSType.HasPropertyKind getPropertyKind(Property.Key propertyName,
 boolean autobox)

Description copied from class: JSType

Checks whether the property is present on the object.

Overrides:

getPropertyKind in class JSType

Parameters:

propertyName - The property name.

autobox - Whether to check for the presents on an autoboxed type