Class NoObjectType
java.lang.Object
com.google.javascript.rhino.jstype.JSType
com.google.javascript.rhino.jstype.ObjectType
com.google.javascript.rhino.jstype.FunctionType
com.google.javascript.rhino.jstype.NoObjectType
- All Implemented Interfaces:
StaticScope<JSType>,Serializable
- Direct Known Subclasses:
NoType
The bottom Object type, representing the subclass of all objects.
Although JavaScript programmers can't explicitly denote the bottom
Object type, it comes up in static analysis. For example, if we have:
var x = function() {};
if (x instanceof Array) {
f(x);
}
We need to be able to assign x a type within the f(x)
call. It has no possible type, but x would not be legal if f
expected a string. So we assign it the NoObjectType.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.javascript.rhino.jstype.JSType
JSType.TypePair -
Field Summary
Fields inherited from class com.google.javascript.rhino.jstype.JSType
EMPTY_TYPE_COMPONENT, ENUMDECL, NOT_A_CLASS, NOT_A_TYPE, NOT_ENUMDECL, templateTypeMap, UNKNOWN_NAME -
Method Summary
Modifier and TypeMethodDescriptionGets this object's constructor.Gets the interfaces extended by the interface associated with this type.Gets the interfaces implemented by the ctor associated with this type.Gets the implicit prototype (a.k.a.Gets the owner of this if it's a function prototype.Gets the reference name for this object.inthashCode()booleanReturns true if the object is named.booleanWhether this is a built-in object.booleanbooleanA function is a subtype of another if their call methods are related via subtyping andthisis a subtype ofthatwith regard to the prototype chain.voidmatchConstraint(JSType constraint) Modify this type so that it matches the specified type.booleanThis predicate is used to test whether a given type can appear in a numeric context, such as an operand of a multiply operator.booleanThis predicate is used to test whether a given type can appear in anObjectcontext, such as the expression in a with statement.booleanThis predicate is used to test whether a given type can appear in aStringcontext, such as an operand of a string concat (+) operator.voidmatchRecordTypeConstraint(ObjectType constraintObj) booleanremoveProperty(String name) Removes the declared or inferred property from this ObjectType.voidsetPropertyJSDocInfo(String propertyName, JSDocInfo info) Sets the docInfo for the specified property from theJSDocInfoon its definition.Downcasts this to a FunctionType, or returns null if this is not a function.Turn an object type to its corresponding scalar type.<T> TVisit this type with the given visitor.Methods inherited from class com.google.javascript.rhino.jstype.FunctionType
canBeCalled, clearCachedValues, cloneWithoutArrowType, getAllExtendedInterfaces, getAllImplementedInterfaces, getBindReturnType, getExtendedInterfaces, getExtendedInterfacesCount, getImplementedInterfaces, getInstanceType, getMaxArguments, getMinArguments, getOwnImplementedInterfaces, getOwnPropertyNames, getParameters, getParametersNode, getPropertyType, getPrototype, getReturnType, getSlot, getSource, getSubTypes, getSuperClassConstructor, getTopDefiningInterface, getTopMostDefiningType, getTypeOfThis, hasAnyTemplateTypesInternal, hasCachedValues, hasEqualCallType, hasImplementedInterfaces, hasInstanceType, isConstructor, isInstanceType, isInterface, isOrdinaryFunction, isReturnTypeInferred, makesDicts, makesStructs, setDict, setExtendedInterfaces, setImplementedInterfaces, setPrototypeBasedOn, setSource, setStruct, toDebugHashCodeStringMethods inherited from class com.google.javascript.rhino.jstype.ObjectType
cast, createDelegateSuffix, defineDeclaredProperty, defineInferredProperty, defineSynthesizedProperty, findPropertyType, getDisplayName, getJSDocInfo, getNormalizedReferenceName, getOwnPropertyJSDocInfo, getOwnSlot, getParentScope, getPossibleToBooleanOutcomes, getPropertiesCount, getPropertyNames, getPropertyNode, getRootNode, getTemplateTypes, hasOwnProperty, hasProperty, isFunctionPrototypeType, isObject, isPropertyInExterns, isPropertyTypeDeclared, isPropertyTypeInferred, isUnknownType, setJSDocInfo, testForEqualityMethods inherited from class com.google.javascript.rhino.jstype.JSType
autobox, autoboxesTo, canCastTo, canTestForEqualityWith, canTestForShallowEqualityWith, clearResolved, collapseUnion, dereference, differsFrom, equals, forceResolve, getGreatestSubtype, getLeastSupertype, getRestrictedTypeGivenToBooleanOutcome, getTemplateTypeMap, getTypesUnderEquality, getTypesUnderInequality, getTypesUnderShallowEquality, getTypesUnderShallowInequality, hasAnyTemplateTypes, hasDisplayName, isAllType, isArrayType, isBooleanObjectType, isBooleanValueType, isCheckedUnknownType, isDateType, isDict, isEmptyType, isEnumElementType, isEnumType, isEquivalent, isEquivalentTo, isFunctionType, isGlobalThisType, isInvariant, isNominalConstructor, isNominalType, isNoResolvedType, isNoType, isNullable, isNullType, isNumber, isNumberObjectType, isNumberValueType, isRecordType, isRegexpType, isResolved, isString, isStringObjectType, isStringValueType, isStruct, isTemplateType, isTemplatizedType, isUnionType, isVoidType, matchesInt32Context, matchesUint32Context, resolve, restrictByNotNullOrUndefined, setValidator, toAnnotationString, toMaybeEnumElementType, toMaybeEnumType, toMaybeFunctionType, toMaybeTemplateType, toMaybeTemplateType, toMaybeTemplatizedType, toMaybeTemplatizedType, toMaybeUnionType, toObjectType, toString
-
Method Details
-
isSubtype
Description copied from class:FunctionTypeA function is a subtype of another if their call methods are related via subtyping andthisis a subtype ofthatwith regard to the prototype chain.- Overrides:
isSubtypein classFunctionType- Returns:
this <: that
-
toMaybeFunctionType
Description copied from class:JSTypeDowncasts this to a FunctionType, or returns null if this is not a function. For the purposes of this function, we define a MaybeFunctionType as any type in the sub-lattice { x | LEAST_FUNCTION_TYPE <= x <= GREATEST_FUNCTION_TYPE } This definition excludes bottom types like NoType and NoObjectType. This definition is somewhat arbitrary and axiomatic, but this is the definition that makes the most sense for the most callers.- Overrides:
toMaybeFunctionTypein classFunctionType
-
isNoObjectType
public boolean isNoObjectType()- Overrides:
isNoObjectTypein classJSType
-
getImplicitPrototype
Description copied from class:ObjectTypeGets the implicit prototype (a.k.a. the[[Prototype]]property). -
getReferenceName
Description copied from class:ObjectTypeGets 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.- Returns:
- the object's name or
nullif this is an anonymous object
-
matchesNumberContext
public boolean matchesNumberContext()Description copied from class:JSTypeThis predicate is used to test whether a given type can appear in a numeric context, such as an operand of a multiply operator. -
matchesObjectContext
public boolean matchesObjectContext()Description copied from class:JSTypeThis predicate is used to test whether a given type can appear in anObjectcontext, 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. -
matchesStringContext
public boolean matchesStringContext()Description copied from class:JSTypeThis predicate is used to test whether a given type can appear in aStringcontext, 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. -
hashCode
public int hashCode()- Overrides:
hashCodein classFunctionType
-
removeProperty
Description copied from class:ObjectTypeRemoves the declared or inferred property from this ObjectType.- Parameters:
name- the property's name- Returns:
- true if the property was removed successfully. False if the property did not exist, or could not be removed.
-
setPropertyJSDocInfo
Description copied from class:ObjectTypeSets the docInfo for the specified property from theJSDocInfoon its definition.info-JSDocInfofor the property definition. May benull.
-
visit
Description copied from class:JSTypeVisit this type with the given visitor.- Overrides:
visitin classFunctionType- Returns:
- the value returned by the visitor
- See Also:
-
getConstructor
Description copied from class:ObjectTypeGets this object's constructor.- Returns:
- this object's constructor or
nullif it is a native object (constructed natively v.s. by instantiation of a function)
-
unboxesTo
Description copied from class:JSTypeTurn an object type to its corresponding scalar type. -
hasReferenceName
public boolean hasReferenceName()Description copied from class:ObjectTypeReturns true if the object is named.- Overrides:
hasReferenceNamein classObjectType- Returns:
- true if the object is named, false if it is anonymous
-
isNativeObjectType
public boolean isNativeObjectType()Whether this is a built-in object.- Overrides:
isNativeObjectTypein classObjectType
-
getOwnerFunction
Description copied from class:ObjectTypeGets the owner of this if it's a function prototype.- Overrides:
getOwnerFunctionin classObjectType
-
getCtorImplementedInterfaces
Description copied from class:ObjectTypeGets the interfaces implemented by the ctor associated with this type. Intended to be overridden by subclasses.- Overrides:
getCtorImplementedInterfacesin classObjectType
-
getCtorExtendedInterfaces
Description copied from class:ObjectTypeGets the interfaces extended by the interface associated with this type. Intended to be overridden by subclasses.- Overrides:
getCtorExtendedInterfacesin classObjectType
-
matchConstraint
Description copied from class:JSTypeModify this type so that it matches the specified type. This is useful for reverse type-inference, where we want to infer that an object literal matches its constraint (much like how the java compiler does reverse-inference to figure out generics).- Overrides:
matchConstraintin classJSType
-
matchRecordTypeConstraint
-