Class ProxyObjectType
- java.lang.Object
-
- com.google.javascript.rhino.jstype.JSType
-
- com.google.javascript.rhino.jstype.ObjectType
-
- com.google.javascript.rhino.jstype.ProxyObjectType
-
- All Implemented Interfaces:
java.io.Serializable
- Direct Known Subclasses:
NamedType
,TemplateType
,TemplatizedType
public class ProxyObjectType extends ObjectType
An object type which uses composition to delegate all calls.- See Also:
NamedType
,TemplatizedType
, 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.JSType
collapseUnion()
Gets the least supertype of this that's not a union.protected JSType
findPropertyTypeWithoutConsideringTemplateTypes(java.lang.String propertyName)
Looks up a property on this type, but without properly replacing any templates in the result.FunctionType
getConstructor()
Gets this object's constructor.java.lang.Iterable<ObjectType>
getCtorExtendedInterfaces()
Gets the interfaces extended by the interface associated with this type.java.lang.Iterable<ObjectType>
getCtorImplementedInterfaces()
Gets the interfaces implemented by the ctor associated with this type.ObjectType
getImplicitPrototype()
Gets the implicit prototype (a.k.a.JSDocInfo
getJSDocInfo()
Gets the docInfo for this type.FunctionType
getOwnerFunction()
JSType.HasPropertyKind
getPropertyKind(java.lang.String propertyName, boolean autobox)
Checks whether the property is present on the object.java.lang.String
getReferenceName()
Gets the reference name for this object.int
getTemplateParamCount()
Return the number of template parameters declared for this type.TemplateTypeMap
getTemplateTypeMap()
Returns the template type map associated with this type.com.google.common.collect.ImmutableList<JSType>
getTemplateTypes()
Gets the declared default element type.JSType
getTypeOfThis()
boolean
hasAnyTemplateTypesInternal()
boolean
isAllType()
boolean
isCheckedUnknownType()
boolean
isConstructor()
Whether this type is aFunctionType
that is a constructor or a named type that points to such a type.boolean
isDict()
Returns true iffthis
can be adict
.boolean
isInstanceType()
Whether this type is an Instance object of some constructor.boolean
isInterface()
Whether this type is aFunctionType
that is an interface or a named type that points to such a type.boolean
isNativeObjectType()
Whether this is a built-in object.boolean
isNominalType()
Whether this type is a nominal type (a named instance object or a named enum).boolean
isNoObjectType()
boolean
isNoResolvedType()
boolean
isNoType()
boolean
isNullable()
Tests whether this type is nullable.boolean
isOrdinaryFunction()
Whether this type is aFunctionType
that is an ordinary function (i.e.boolean
isStruct()
Returns true iffthis
can be astruct
.boolean
isStructuralType()
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
loosenTypecheckingDueToForwardReferencedSupertype()
During type definition, was one of the supertypes of this type a forward reference?void
matchConstraint(JSType constraint)
Modify this type so that it matches the specified type.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.boolean
removeProperty(java.lang.String name)
Removes the declared or inferred property from this ObjectType.void
setJSDocInfo(JSDocInfo info)
Sets the docInfo for this type from the givenJSDocInfo
.void
setPropertyJSDocInfo(java.lang.String propertyName, JSDocInfo info)
Sets the docInfo for the specified property from theJSDocInfo
on its definition.boolean
setValidator(com.google.common.base.Predicate<JSType> validator)
Certain types have constraints on them at resolution-time.TernaryValue
testForEquality(JSType that)
Comparesthis
andthat
.EnumElementType
toMaybeEnumElementType()
Downcasts this to an EnumElementType, or returns null if this is not an EnumElementType.EnumType
toMaybeEnumType()
Downcasts this to an EnumType, or returns null if this is not an EnumType.FunctionType
toMaybeFunctionType()
Downcasts this to a FunctionType, or returns null if this is not a function.RecordType
toMaybeRecordType()
Downcasts this to a RecordType, or returns null if this is not a RecordType.TemplateType
toMaybeTemplateType()
Downcasts this to a TemplateType, or returns null if this is not a function.TemplatizedType
toMaybeTemplatizedType()
Downcasts this to a TemplatizedType, or returns null if this is not a function.UnionType
toMaybeUnionType()
Downcasts this to a UnionType, or returns null if this is not a UnionType.<T> T
visit(Visitor<T> visitor)
Visit this type with the given visitor.<T> T
visitReferenceType(Visitor<T> visitor)
-
Methods inherited from class com.google.javascript.rhino.jstype.ObjectType
cast, clearCachedValues, createDelegateSuffix, defineDeclaredProperty, defineInferredProperty, defineSynthesizedProperty, findClosestDefinition, getClosestDefiningType, getDisplayName, getEnumeratedTypeOfEnumObject, getImplicitPrototypeChain, getNormalizedReferenceName, getOwnPropertyDefSite, getOwnPropertyJSDocInfo, getOwnPropertyKind, getOwnPropertyNames, getOwnSlot, getPossibleToBooleanOutcomes, getPropertiesCount, getPropertyDefSite, getPropertyJSDocInfo, getPropertyNames, getPropertyNode, getPropertyType, getPropertyTypeMap, getRawType, getSlot, getSuperClassConstructor, getTopMostDefiningType, hasCachedValues, hasOwnProperty, hasReferenceName, isAmbiguousObject, isFunctionPrototypeType, isObject, isPropertyInExterns, isPropertyTypeDeclared, isPropertyTypeInferred, setPropertyNode
-
Methods inherited from class com.google.javascript.rhino.jstype.JSType
areIdentical, assertFunctionType, assertObjectType, autobox, autoboxesTo, canCastTo, canTestForEqualityWith, canTestForShallowEqualityWith, containsReferenceAncestor, dereference, differsFrom, equals, findPropertyType, getEnumeratedTypeOfEnumElement, getGreatestSubtype, getGreatestSubtypeWithProperty, getLeastSupertype, getPropertyKind, getRestrictedTypeGivenOutcome, getTypeParameters, getTypesUnderEquality, getTypesUnderInequality, getTypesUnderShallowEquality, getTypesUnderShallowInequality, getUnionMembers, hasAnyTemplateTypes, hasDisplayName, hashCode, hasProperty, isArrayType, isBigIntObjectType, isBigIntOrNumber, isBigIntValueType, isBooleanObjectType, isBooleanValueType, isBoxableScalar, isDateType, isEmptyType, isEnumElementType, isEnumType, isExplicitlyVoidable, isFunctionType, isGlobalThisType, isLiteralObject, isNamedType, isNominalConstructor, isNullType, isNumber, isNumberObjectType, isNumberValueType, isObjectType, isOnlyBigInt, isRawTypeOfTemplatizedType, isRecordType, isRegexpType, isResolved, isSomeUnknownType, isString, isStringObjectType, isStringValueType, isStructuralInterface, isSubtype, isSubtype, isSubtypeOf, isSubtypeOf, isSubtypeWithoutStructuralTyping, isSuccessfullyResolved, isSymbol, isSymbolObjectType, isSymbolValueType, isTemplateType, isTemplatizedType, isUnionType, isUnresolved, isUnresolvedOrResolvedUnknown, isUnsuccessfullyResolved, isVoidType, mergeSupertypeTemplateTypes, resolve, restrictByNotNull, restrictByNotNullOrUndefined, restrictByNotUndefined, toAnnotationString, toMaybeFunctionType, toMaybeNamedType, toMaybeObjectType, toObjectType, toString, unboxesTo
-
-
-
-
Method Detail
-
getPropertyKind
public final JSType.HasPropertyKind getPropertyKind(java.lang.String propertyName, boolean autobox)
Description copied from class:JSType
Checks whether the property is present on the object.- Overrides:
getPropertyKind
in classObjectType
- Parameters:
propertyName
- The property name.autobox
- Whether to check for the presents on an autoboxed type
-
loosenTypecheckingDueToForwardReferencedSupertype
public final boolean loosenTypecheckingDueToForwardReferencedSupertype()
Description copied from class:JSType
During type definition, was one of the supertypes of this type a forward reference?This is a hack to work around the fact that inheritance chains and template types aren't wired up correctly when this happens, which causes various false positives in checks. The known bugs associated are b/145145406, b/144327372, and b/132980305.
This method should only be used to suppress potential false positives caused by one of the above bugs, in the case where we think suppressing typechecking is preferable to emitting a false positive.
- Overrides:
loosenTypecheckingDueToForwardReferencedSupertype
in classJSType
-
setValidator
public boolean setValidator(com.google.common.base.Predicate<JSType> validator)
Description copied from class:JSType
Certain types have constraints on them at resolution-time. For example, a type in an@extends
annotation must be an object. Clients should inject a validator that emits a warning if the type does not validate, and return false.- Overrides:
setValidator
in classJSType
-
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
-
matchesNumberContext
public final 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
-
matchesStringContext
public final 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 final 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
-
matchesObjectContext
public final 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
-
canBeCalled
public final 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.
-
isStructuralType
public final boolean isStructuralType()
- Overrides:
isStructuralType
in classObjectType
-
isNoObjectType
public final boolean isNoObjectType()
- Overrides:
isNoObjectType
in classJSType
-
isNoResolvedType
public final boolean isNoResolvedType()
- Overrides:
isNoResolvedType
in classJSType
-
isUnknownType
public final 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 final boolean isCheckedUnknownType()
- Overrides:
isCheckedUnknownType
in classJSType
-
isNullable
public final boolean isNullable()
Description copied from class:JSType
Tests whether this type is nullable.- Overrides:
isNullable
in classJSType
-
isVoidable
public final boolean isVoidable()
Description copied from class:JSType
Tests whether this type is voidable.- Overrides:
isVoidable
in classJSType
-
toMaybeEnumType
public final EnumType toMaybeEnumType()
Description copied from class:JSType
Downcasts this to an EnumType, or returns null if this is not an EnumType.- Overrides:
toMaybeEnumType
in classJSType
-
isConstructor
public final boolean isConstructor()
Description copied from class:JSType
Whether this type is aFunctionType
that is a constructor or a named type that points to such a type.- Overrides:
isConstructor
in classJSType
-
isNominalType
public boolean isNominalType()
Description copied from class:JSType
Whether this type is a nominal type (a named instance object or a named enum).- Overrides:
isNominalType
in classJSType
-
isInstanceType
public final boolean isInstanceType()
Description copied from class:JSType
Whether this type is an Instance object of some constructor. Does not necessarily mean this is anInstanceObjectType
.- Overrides:
isInstanceType
in classJSType
-
isInterface
public final boolean isInterface()
Description copied from class:JSType
Whether this type is aFunctionType
that is an interface or a named type that points to such a type.- Overrides:
isInterface
in classJSType
-
isOrdinaryFunction
public final boolean isOrdinaryFunction()
Description copied from class:JSType
Whether this type is aFunctionType
that is an ordinary function (i.e. not a constructor, nominal interface, or record interface), or a named type that points to such a type.- Overrides:
isOrdinaryFunction
in classJSType
-
isStruct
public final boolean isStruct()
Description copied from class:JSType
Returns true iffthis
can be astruct
. UnionType overrides the method, assumethis
is not a union here.
-
isDict
public final boolean isDict()
Description copied from class:JSType
Returns true iffthis
can be adict
. UnionType overrides the method, assumethis
is not a union here.
-
isNativeObjectType
public final boolean isNativeObjectType()
Description copied from class:ObjectType
Whether this is a built-in object.- Overrides:
isNativeObjectType
in classObjectType
-
toMaybeRecordType
public final RecordType toMaybeRecordType()
Description copied from class:JSType
Downcasts this to a RecordType, or returns null if this is not a RecordType.- Overrides:
toMaybeRecordType
in classJSType
-
toMaybeUnionType
public final UnionType toMaybeUnionType()
Description copied from class:JSType
Downcasts this to a UnionType, or returns null if this is not a UnionType. Named in honor of Haskell's Maybe type constructor.- Overrides:
toMaybeUnionType
in classJSType
-
toMaybeFunctionType
public final FunctionType toMaybeFunctionType()
Description copied from class:JSType
Downcasts 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:
toMaybeFunctionType
in classJSType
-
toMaybeEnumElementType
public final EnumElementType toMaybeEnumElementType()
Description copied from class:JSType
Downcasts this to an EnumElementType, or returns null if this is not an EnumElementType.- Overrides:
toMaybeEnumElementType
in classJSType
-
testForEquality
public final 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
-
getOwnerFunction
public final FunctionType getOwnerFunction()
- Overrides:
getOwnerFunction
in classObjectType
-
getCtorImplementedInterfaces
public java.lang.Iterable<ObjectType> getCtorImplementedInterfaces()
Description copied from class:ObjectType
Gets the interfaces implemented by the ctor associated with this type. Intended to be overridden by subclasses.- Overrides:
getCtorImplementedInterfaces
in classObjectType
-
getCtorExtendedInterfaces
public java.lang.Iterable<ObjectType> getCtorExtendedInterfaces()
Description copied from class:ObjectType
Gets the interfaces extended by the interface associated with this type. Intended to be overridden by subclasses.- Overrides:
getCtorExtendedInterfaces
in classObjectType
-
getImplicitPrototype
public final ObjectType getImplicitPrototype()
Description copied from class:ObjectType
Gets the implicit prototype (a.k.a. the[[Prototype]]
property).- Specified by:
getImplicitPrototype
in classObjectType
-
removeProperty
public final boolean removeProperty(java.lang.String name)
Description copied from class:ObjectType
Removes the declared or inferred property from this ObjectType.- Overrides:
removeProperty
in classObjectType
- 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.
-
findPropertyTypeWithoutConsideringTemplateTypes
protected JSType findPropertyTypeWithoutConsideringTemplateTypes(java.lang.String propertyName)
Description copied from class:JSType
Looks up a property on this type, but without properly replacing any templates in the result.Subclasses can override this if they need more complicated logic for property lookup than just autoboxing to an object.
This is only for use by
findPropertyType(JSType)
. Call that method instead if you need to lookup a property on a random JSType- Overrides:
findPropertyTypeWithoutConsideringTemplateTypes
in classObjectType
-
getJSDocInfo
public final JSDocInfo getJSDocInfo()
Description copied from class:ObjectType
Gets the docInfo for this type.- Overrides:
getJSDocInfo
in classObjectType
-
setJSDocInfo
public final void setJSDocInfo(JSDocInfo info)
Description copied from class:ObjectType
- Overrides:
setJSDocInfo
in classObjectType
-
setPropertyJSDocInfo
public final void setPropertyJSDocInfo(java.lang.String propertyName, JSDocInfo info)
Description copied from class:ObjectType
Sets the docInfo for the specified property from theJSDocInfo
on its definition.- Overrides:
setPropertyJSDocInfo
in classObjectType
info
-JSDocInfo
for the property definition. May benull
.
-
getConstructor
public final 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)
-
getTemplateTypes
public com.google.common.collect.ImmutableList<JSType> getTemplateTypes()
Description copied from class:ObjectType
Gets the declared default element type.- Overrides:
getTemplateTypes
in classObjectType
- See Also:
TemplatizedType
-
getTemplateParamCount
public int getTemplateParamCount()
Description copied from class:JSType
Return the number of template parameters declared for this type.In general, this value corresponds to the number of `@template` declarations on the type definition. It does not include template parameters from superclasses or superinterfaces.
- Overrides:
getTemplateParamCount
in classJSType
-
visitReferenceType
public final <T> T visitReferenceType(Visitor<T> visitor)
-
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
-
getTypeOfThis
public final JSType getTypeOfThis()
- Overrides:
getTypeOfThis
in classObjectType
-
collapseUnion
public final JSType collapseUnion()
Description copied from class:JSType
Gets the least supertype of this that's not a union.- Overrides:
collapseUnion
in classJSType
-
matchConstraint
public final void matchConstraint(JSType constraint)
Description copied from class:JSType
Modify 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:
matchConstraint
in classJSType
-
toMaybeTemplatizedType
public TemplatizedType toMaybeTemplatizedType()
Description copied from class:JSType
Downcasts this to a TemplatizedType, or returns null if this is not a function.- Overrides:
toMaybeTemplatizedType
in classJSType
-
toMaybeTemplateType
public TemplateType toMaybeTemplateType()
Description copied from class:JSType
Downcasts this to a TemplateType, or returns null if this is not a function.- Overrides:
toMaybeTemplateType
in classJSType
-
hasAnyTemplateTypesInternal
public boolean hasAnyTemplateTypesInternal()
-
getTemplateTypeMap
public TemplateTypeMap getTemplateTypeMap()
Description copied from class:JSType
Returns the template type map associated with this type.- Overrides:
getTemplateTypeMap
in classJSType
-
-