Class UnknownType
- java.lang.Object
-
- com.google.javascript.rhino.jstype.JSType
-
- com.google.javascript.rhino.jstype.ObjectType
-
- com.google.javascript.rhino.jstype.UnknownType
-
- All Implemented Interfaces:
java.io.Serializable
public class UnknownType extends ObjectType
TheUnknown
type.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.javascript.rhino.jstype.JSType
JSType.HasPropertyKind, JSType.Nullability, JSType.SubtypingMode, JSType.TypePair
-
-
Field Summary
-
Fields inherited from class com.google.javascript.rhino.jstype.JSType
templateTypeMap
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canBeCalled()
This predicate is used to test whether a given type can be used as the 'function' in a function call.FunctionType
getConstructor()
Gets this object's constructor.java.lang.String
getDisplayName()
Returns a user meaningful label for the JSType instance.ObjectType
getImplicitPrototype()
Gets the implicit prototype (a.k.a.BooleanLiteralSet
getPossibleToBooleanOutcomes()
Computes the set of possible outcomes of theToBoolean
predicate for this type.java.lang.String
getReferenceName()
Gets the reference name for this object.boolean
hasDisplayName()
boolean
isCheckedUnknownType()
boolean
isNullable()
Tests whether this type is nullable.boolean
isUnknownType()
We treat this as the unknown type if any of its implicit prototype properties is unknown.boolean
isVoidable()
Tests whether this type is voidable.boolean
matchesNumberContext()
This predicate is used to test whether a given type can appear in a numeric context, such as an operand of a multiply operator.boolean
matchesObjectContext()
This predicate is used to test whether a given type can appear in anObject
context, such as the expression in a with statement.boolean
matchesStringContext()
This predicate is used to test whether a given type can appear in aString
context, such as an operand of a string concat (+) operator.boolean
matchesSymbolContext()
This predicate is used to test whether a given type can appear in asymbol
context such as property access.TernaryValue
testForEquality(JSType that)
Comparesthis
andthat
.<T> T
visit(Visitor<T> visitor)
Visit this type with the given visitor.-
Methods inherited from class com.google.javascript.rhino.jstype.ObjectType
cast, clearCachedValues, createDelegateSuffix, defineDeclaredProperty, defineInferredProperty, defineSynthesizedProperty, findClosestDefinition, findPropertyTypeWithoutConsideringTemplateTypes, getClosestDefiningType, getCtorExtendedInterfaces, getCtorImplementedInterfaces, getEnumeratedTypeOfEnumObject, getImplicitPrototypeChain, getJSDocInfo, getNormalizedReferenceName, getOwnerFunction, getOwnPropertyDefSite, getOwnPropertyJSDocInfo, getOwnPropertyKind, getOwnPropertyNames, getOwnSlot, getPropertiesCount, getPropertyDefSite, getPropertyJSDocInfo, getPropertyKind, getPropertyNames, getPropertyNode, getPropertyType, getPropertyTypeMap, getRawType, getSlot, getSuperClassConstructor, getTemplateTypes, getTopMostDefiningType, getTypeOfThis, hasCachedValues, hasOwnProperty, hasReferenceName, isFunctionPrototypeType, isNativeObjectType, isObject, isPropertyInExterns, isPropertyTypeDeclared, isPropertyTypeInferred, isStructuralType, removeProperty, setJSDocInfo, setPropertyJSDocInfo, setPropertyNode
-
Methods inherited from class com.google.javascript.rhino.jstype.JSType
areIdentical, assertFunctionType, assertObjectType, autobox, autoboxesTo, canCastTo, canTestForEqualityWith, canTestForShallowEqualityWith, collapseUnion, containsReferenceAncestor, dereference, differsFrom, equals, findPropertyType, getEnumeratedTypeOfEnumElement, getGreatestSubtype, getGreatestSubtypeWithProperty, getLeastSupertype, getPropertyKind, getRestrictedTypeGivenOutcome, getTemplateParamCount, getTemplateTypeMap, getTypeParameters, getTypesUnderEquality, getTypesUnderInequality, getTypesUnderShallowEquality, getTypesUnderShallowInequality, getUnionMembers, hasAnyTemplateTypes, hashCode, hasProperty, isAllType, isArrayType, isBigIntObjectType, isBigIntOrNumber, isBigIntValueType, isBooleanObjectType, isBooleanValueType, isBoxableScalar, isConstructor, isDateType, isDict, isEmptyType, isEnumElementType, isEnumType, isExplicitlyVoidable, isFunctionType, isGlobalThisType, isInstanceType, isInterface, isLiteralObject, isNamedType, isNominalConstructorOrInterface, isNominalType, isNoObjectType, isNoResolvedType, isNoType, isNullType, isNumber, isNumberObjectType, isNumberValueType, isObjectType, isOnlyBigInt, isOrdinaryFunction, isRawTypeOfTemplatizedType, isRecordType, isRegexpType, isResolved, isSomeUnknownType, isString, isStringObjectType, isStringValueType, isStruct, isStructuralInterface, isSubtype, isSubtype, isSubtypeOf, isSubtypeOf, isSubtypeWithoutStructuralTyping, isSuccessfullyResolved, isSymbol, isSymbolObjectType, isSymbolValueType, isTemplateType, isTemplatizedType, isUnionType, isUnresolved, isUnresolvedOrResolvedUnknown, isUnsuccessfullyResolved, isVoidType, loosenTypecheckingDueToForwardReferencedSupertype, matchConstraint, mergeSupertypeTemplateTypes, resolve, restrictByNotNull, restrictByNotNullOrUndefined, restrictByNotUndefined, setValidator, toAnnotationString, toMaybeEnumElementType, toMaybeEnumType, toMaybeFunctionType, toMaybeFunctionType, toMaybeNamedType, toMaybeObjectType, toMaybeRecordType, toMaybeTemplateType, toMaybeTemplatizedType, toMaybeUnionType, toObjectType, toString, unboxesTo
-
-
-
-
Method Detail
-
isUnknownType
public boolean isUnknownType()
Description copied from class:ObjectType
We treat this as the unknown type if any of its implicit prototype properties is unknown.- Overrides:
isUnknownType
in classObjectType
-
isCheckedUnknownType
public boolean isCheckedUnknownType()
- Overrides:
isCheckedUnknownType
in classJSType
-
canBeCalled
public boolean canBeCalled()
Description copied from class:JSType
This predicate is used to test whether a given type can be used as the 'function' in a function call.- Overrides:
canBeCalled
in classJSType
- Returns:
true
if this type might be callable.
-
matchesNumberContext
public boolean matchesNumberContext()
Description copied from class:JSType
This predicate is used to test whether a given type can appear in a numeric context, such as an operand of a multiply operator.- Overrides:
matchesNumberContext
in classJSType
-
matchesObjectContext
public boolean matchesObjectContext()
Description copied from class:JSType
This predicate is used to test whether a given type can appear in anObject
context, such as the expression in a with statement. Most types we will encounter, except notablynull
, have at least the potential for converting toObject
. Host defined objects can get peculiar.- Overrides:
matchesObjectContext
in classJSType
-
matchesStringContext
public boolean matchesStringContext()
Description copied from class:JSType
This predicate is used to test whether a given type can appear in aString
context, such as an operand of a string concat (+) operator. All types have at least the potential for converting toString
. When we add externally defined types, such as a browser OM, we may choose to add types that do not automatically convert toString
.- Overrides:
matchesStringContext
in classJSType
-
matchesSymbolContext
public boolean matchesSymbolContext()
Description copied from class:JSType
This predicate is used to test whether a given type can appear in asymbol
context such as property access.- Overrides:
matchesSymbolContext
in classJSType
-
testForEquality
public TernaryValue testForEquality(JSType that)
Description copied from class:JSType
Comparesthis
andthat
.- Overrides:
testForEquality
in classObjectType
- Returns:
TernaryValue.TRUE
if the comparison of values ofthis
type andthat
always succeed (such asundefined
compared tonull
)TernaryValue.FALSE
if the comparison of values ofthis
type andthat
always fails (such asundefined
compared tonumber
)TernaryValue.UNKNOWN
if the comparison can succeed or fail depending on the concrete values
-
isNullable
public boolean isNullable()
Description copied from class:JSType
Tests whether this type is nullable.- Overrides:
isNullable
in classJSType
-
isVoidable
public boolean isVoidable()
Description copied from class:JSType
Tests whether this type is voidable.- Overrides:
isVoidable
in classJSType
-
visit
public <T> T visit(Visitor<T> visitor)
Description copied from class:JSType
Visit this type with the given visitor.- Overrides:
visit
in classObjectType
- Returns:
- the value returned by the visitor
- See Also:
Visitor
-
getImplicitPrototype
public ObjectType getImplicitPrototype()
Description copied from class:ObjectType
Gets the implicit prototype (a.k.a. the[[Prototype]]
property).- Specified by:
getImplicitPrototype
in classObjectType
-
getConstructor
public FunctionType getConstructor()
Description copied from class:ObjectType
Gets this object's constructor.- Specified by:
getConstructor
in classObjectType
- Returns:
- this object's constructor or
null
if it is a native object (constructed natively v.s. by instantiation of a function)
-
getReferenceName
public java.lang.String getReferenceName()
Description copied from class:ObjectType
Gets the reference name for this object. This includes named types like constructors, prototypes, and enums. It notably does not include literal types like strings and booleans and structural types.Returning an empty string means something different than returning null. An empty string may indicate an anonymous constructor, which we treat differently than a literal type without a reference name. e.g. in
InstanceObjectType.appendTo(TypeStringBuilder)
- Specified by:
getReferenceName
in classObjectType
- Returns:
- the object's name or
null
if this is an anonymous object
-
getDisplayName
public java.lang.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 classObjectType
- Returns:
- the display name of the type, or null if one is not available
-
hasDisplayName
public boolean hasDisplayName()
- Overrides:
hasDisplayName
in classJSType
- Returns:
- true if the JSType has a user meaningful label.
-
getPossibleToBooleanOutcomes
public BooleanLiteralSet getPossibleToBooleanOutcomes()
Description copied from class:JSType
Computes the set of possible outcomes of theToBoolean
predicate for this type. TheToBoolean
predicate is defined by the ECMA-262 standard, 3rd edition. Its behavior for simple types can be summarized by the following table:ToBoolean results by input type type result undefined
{false} null
{false} boolean
{true, false} number
{true, false} string
{true, false} Object
{true} - Overrides:
getPossibleToBooleanOutcomes
in classObjectType
- Returns:
- the set of boolean literals for this type
-
-