com.google.javascript.rhino.jstype

Class FunctionType

java.lang.Object

com.google.javascript.rhino.jstype.JSType

com.google.javascript.rhino.jstype.ObjectType

com.google.javascript.rhino.jstype.PrototypeObjectType

com.google.javascript.rhino.jstype.FunctionType

All Implemented Interfaces:

FunctionTypeI, ObjectTypeI, TypeI, java.io.Serializable

Direct Known Subclasses:

NoObjectType

public class FunctionType
extends PrototypeObjectType
implements FunctionTypeI

This derived type provides extended information about a function, including its return type and argument types.

Note: the parameters list is the PARAM_LIST node that is the parent of the actual NAME node containing the parsed argument list (annotated with JSDOC_TYPE_PROP's for the compile-time type of each argument.

See Also:

Serialized Form

Nested Class Summary

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

JSType.HasPropertyKind, JSType.SubtypingMode, JSType.TypePair

Nested classes/interfaces inherited from interface com.google.javascript.rhino.FunctionTypeI

FunctionTypeI.Builder

Nested classes/interfaces inherited from interface com.google.javascript.rhino.TypeI

TypeI.Nullability, TypeI.TypeInference

Field Summary

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

templateTypeMap

Method Summary

Modifier and Type	Method and Description
boolean	acceptsArguments(java.util.List<? extends TypeI> argumentTypes) Checks if a call to this function with the given list of arguments is valid.
boolean	canBeCalled() This predicate is used to test whether a given type can be used as the 'function' in a function call.
java.util.List<FunctionType>	checkExtendsLoop() check if there is a loop in the type extends chain
java.util.List<FunctionType>	checkExtendsLoop(java.util.HashSet<FunctionType> cache, java.util.List<FunctionType> path)
void	clearCachedValues() Clear cached values.
TypeI	convertMethodToFunction() Creates a new function type B based on the original function type A.
boolean	explicitlyImplOrExtInterface(FunctionType interfaceType) check whether or not this function type has implemented the given interface if this function is an interface, check whether or not this interface has extended the given interface
void	extendTemplateTypeMapBasedOn(ObjectType type) Extends the TemplateTypeMap of the function's this type, based on the specified type.
java.lang.Iterable<ObjectType>	getAllImplementedInterfaces() Returns all interfaces implemented by a class or its superclass and any superclasses for any of those interfaces.
java.util.Collection<ObjectTypeI>	getAncestorInterfaces()
FunctionType	getBindReturnType(int argsToBind) Get the return value of calling "bind" on this function with the specified number of arguments.
java.lang.Iterable<FunctionTypeI>	getDirectSubTypes() Returns an iterable of direct types that are subtypes of this type.
java.lang.Iterable<ObjectType>	getExtendedInterfaces() Returns interfaces directly extended by an interface
int	getExtendedInterfacesCount() Returns the number of interfaces directly extended by an interface
java.lang.Iterable<ObjectType>	getImplementedInterfaces() Returns interfaces implemented directly by a class or its superclass.
ObjectType	getInstanceType() Gets the type of instance of this function.
int	getMaxArity() Gets the maximum number of arguments that this function requires, or Integer.MAX_VALUE if this is a variable argument function.
int	getMinArity() Gets the minimum number of arguments that this function requires.
java.lang.Iterable<ObjectType>	getOwnImplementedInterfaces() Returns interfaces directly implemented by the class.
java.util.Set<java.lang.String>	getOwnPropertyNames() Includes the prototype iff someone has created it.
java.lang.Iterable<Node>	getParameters()
Node	getParametersNode() Gets a PARAM_LIST node that contains all params.
java.lang.Iterable<TypeI>	getParameterTypes()
JSType	getPropertyType(java.lang.String name) Gets the property type of the property whose name is given.
java.util.Map<java.lang.String,JSType>	getPropertyTypeMap() get the map of properties to types covered in a function type
ObjectType	getPrototype() Gets the prototype property of this function type.
ObjectType	getPrototypeProperty()
JSType	getReturnType()
Property	getSlot(java.lang.String name) Default getSlot implementation.
Node	getSource() Gets the source node or null if this is an unknown function.
FunctionType	getSuperClassConstructor() Given a constructor or an interface type, get its superclass constructor or null if none exists.
ObjectType	getTopMostDefiningType(java.lang.String propertyName) Given a constructor or an interface type and a property, finds the top-most superclass that has the property defined (including this constructor).
JSType	getTypeOfThis() Gets the type of this in this function.
boolean	hasAnyTemplateTypesInternal()
boolean	hasCachedValues() Returns true if any cached values have been set for this type.
boolean	hasEqualCallType(FunctionType otherType)
int	hashCode()
boolean	hasImplementedInterfaces()
boolean	hasInstanceType() Returns whether this function type has an instance type.
boolean	hasProperties() Whether this function type has any properties (not counting "prototype").
boolean	isAbstract()
boolean	isConstructor() Whether this type is a FunctionType that is a constructor or a named type that points to such a type.
boolean	isInstanceType() Whether this type is an Instance object of some constructor.
boolean	isInterface() Whether this type is a FunctionType that is an interface or a named type that points to such a type.
boolean	isOrdinaryFunction() Whether this type is a FunctionType that is an ordinary function or a named type that points to such a type.
boolean	isReturnTypeInferred()
boolean	isStructuralInterface()
boolean	isSubtype(JSType that) A function is a subtype of another if their call methods are related via subtyping and this is a subtype of that with regard to the prototype chain.
protected boolean	isSubtype(JSType that, com.google.javascript.rhino.jstype.JSType.ImplCache implicitImplCache, JSType.SubtypingMode subtypingMode) checking isSubtype with structural interface matching
boolean	makesDicts() When a class B inherits from A and A is annotated as a dict, then B automatically gets the annotation, even if B's constructor is not explicitly annotated.
boolean	makesStructs() When a class B inherits from A and A is annotated as a struct, then B automatically gets the annotation, even if B's constructor is not explicitly annotated.
void	setDict()
void	setExtendedInterfaces(java.util.List<ObjectType> extendedInterfaces)
void	setImplementedInterfaces(java.util.List<ObjectType> implementedInterfaces)
void	setImplicitMatch(boolean flag) sets the current interface type to support structural interface matching (abbr.
void	setPrototypeBasedOn(ObjectType baseType) Sets the prototype, creating the prototype object from the given base type.
void	setSource(Node source) Sets the source node.
void	setStruct()
FunctionTypeI.Builder	toBuilder() Returns a Builder instance initialized to this function.
java.lang.String	toDebugHashCodeString() A hash code function for diagnosing complicated issues around type-identity.
FunctionType	toMaybeFunctionType() Downcasts this to a FunctionType, or returns null if this is not a function.
<T> T	visit(Visitor<T> visitor) Visit this type with the given visitor.

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

getConstructor, getCtorExtendedInterfaces, getCtorImplementedInterfaces, getImplicitPrototype, getOwnerFunction, getReferenceName, hasReferenceName, isAnonymous, isNativeObjectType, matchConstraint, matchesNumberContext, matchesObjectContext, matchesStringContext, matchesSymbolContext, matchRecordTypeConstraint, removeProperty, setPropertyJSDocInfo, setPropertyNode, unboxesTo

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

cast, createDelegateSuffix, defineDeclaredProperty, defineInferredProperty, defineSynthesizedProperty, findPropertyType, getDisplayName, getEnumeratedTypeOfEnumObject, getInstantiatedTypeArgument, getJSDocInfo, getLegacyResolvedType, getNormalizedReferenceName, getOwnPropertyDefSite, getOwnPropertyJSDocInfo, getOwnPropertyKind, getOwnSlot, getParentScope, getPossibleToBooleanOutcomes, getPropertiesCount, getPropertyDefSite, getPropertyJSDocInfo, getPropertyKind, getPropertyNames, getPropertyNode, getPrototypeObject, getRawType, getTemplateTypes, getTopDefiningInterface, hasOwnProperty, instantiateGenericsWithUnknown, isAmbiguousObject, isFunctionPrototypeType, isObject, isPropertyInExterns, isPropertyTypeDeclared, isPropertyTypeInferred, isStructuralType, isUnknownType, normalizeObjectForCheckAccessControls, setJSDocInfo, testForEquality, withoutStrayProperties

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

autobox, autoboxAndGetObject, autoboxesTo, canCastTo, canTestForEqualityWith, canTestForShallowEqualityWith, collapseUnion, containsArray, dereference, differsFrom, equals, extendTemplateTypeMap, getEnumeratedTypeOfEnumElement, getGreatestSubtype, getGreatestSubtypeWithProperty, getLeastSupertype, getPropertyKind, getRestrictedTypeGivenToBooleanOutcome, getTemplateTypeMap, getTypeParameters, getTypesUnderEquality, getTypesUnderInequality, getTypesUnderShallowEquality, getTypesUnderShallowInequality, getUnionMembers, hasAnyTemplateTypes, hasDisplayName, hasProperty, isAllType, isArrayType, isBooleanObjectType, isBooleanValueType, isBottom, isBoxableScalar, isCheckedUnknownType, isDateType, isDict, isEmptyType, isEnumElement, isEnumElementType, isEnumObject, isEnumType, isEquivalent, isEquivalentTo, isEquivalentTo, isExplicitlyVoidable, isFullyInstantiated, isFunctionType, isGenericObjectType, isGlobalThisType, isInstanceofObject, isLegacyNamedType, isLiteralObject, isNamedType, isNominalConstructor, isNominalType, isNoObjectType, isNoResolvedType, isNoType, isNullable, isNullType, isNumber, isNumberObjectType, isNumberValueType, isObjectType, isPartiallyInstantiated, isPrototypeObject, isRecordType, isRegexpType, isResolved, isSomeUnknownType, isString, isStringObjectType, isStringValueType, isStruct, isSubtype, isSubtypeOf, isSubtypeWithoutStructuralTyping, isSymbol, isSymbolObjectType, isSymbolValueType, isTemplateType, isTemplatizedType, isTop, isTypeVariable, isUnionType, isUnresolved, isUnresolvedOrResolvedUnknown, isVoidable, isVoidType, meetWith, resolve, restrictByNotNullOrUndefined, setValidator, toAnnotationString, toMaybeEnumElementType, toMaybeEnumType, toMaybeFunctionType, toMaybeNamedType, toMaybeObjectType, toMaybeRecordType, toMaybeTemplateType, toMaybeTemplatizedType, toMaybeUnionType, toObjectType, toString, typeInference

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.javascript.rhino.FunctionTypeI

getReferenceName

Methods inherited from interface com.google.javascript.rhino.ObjectTypeI

getConstructor, getEnumeratedTypeOfEnumObject, getInstantiatedTypeArgument, getLegacyResolvedType, getOwnerFunction, getOwnPropertyDefSite, getOwnPropertyJSDocInfo, getPropertyDefSite, getPropertyJSDocInfo, getPropertyNames, getPrototypeObject, getRawType, getTemplateTypes, getTopDefiningInterface, hasOwnProperty, hasProperty, instantiateGenericsWithUnknown, isAmbiguousObject, isLegacyNamedType, normalizeObjectForCheckAccessControls, withoutStrayProperties

Methods inherited from interface com.google.javascript.rhino.TypeI

autobox, autoboxAndGetObject, containsArray, getDisplayName, getEnumeratedTypeOfEnumElement, getGreatestSubtypeWithProperty, getJSDocInfo, getTypeParameters, getUnionMembers, isBooleanValueType, isBottom, isBoxableScalar, isEnumElement, isEnumObject, isEquivalentTo, isFullyInstantiated, isFunctionType, isGenericObjectType, isInstanceofObject, isLiteralObject, isNullable, isNullType, isNumberValueType, isObjectType, isPartiallyInstantiated, isPrototypeObject, isRecordType, isSomeUnknownType, isStringValueType, isSubtypeOf, isSubtypeWithoutStructuralTyping, isTop, isTypeVariable, isUnionType, isUnknownType, isUnresolved, isUnresolvedOrResolvedUnknown, isVoidable, isVoidType, meetWith, restrictByNotNullOrUndefined, toAnnotationString, toMaybeObjectType, typeInference

Method Detail

isInstanceType

public boolean isInstanceType()

Description copied from class: JSType

Whether this type is an Instance object of some constructor. Does not necessarily mean this is an InstanceObjectType.

Specified by:

isInstanceType in interface ObjectTypeI

Overrides:

isInstanceType in class JSType

isConstructor

public boolean isConstructor()

Description copied from class: JSType

Whether this type is a FunctionType that is a constructor or a named type that points to such a type.

Specified by:

isConstructor in interface TypeI

Overrides:

isConstructor in class JSType

isInterface

public boolean isInterface()

Description copied from class: JSType

Whether this type is a FunctionType that is an interface or a named type that points to such a type.

Specified by:

isInterface in interface TypeI

Overrides:

isInterface in class JSType

Returns:

True for both nominal and structural interfaces

isOrdinaryFunction

public boolean isOrdinaryFunction()

Description copied from class: JSType

Whether this type is a FunctionType that is an ordinary function or a named type that points to such a type.

Overrides:

isOrdinaryFunction in class JSType

makesStructs

public boolean makesStructs()

When a class B inherits from A and A is annotated as a struct, then B automatically gets the annotation, even if B's constructor is not explicitly annotated.

makesDicts

public boolean makesDicts()

When a class B inherits from A and A is annotated as a dict, then B automatically gets the annotation, even if B's constructor is not explicitly annotated.

setStruct

public void setStruct()

setDict

public void setDict()

toMaybeFunctionType

public 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.

Specified by:

toMaybeFunctionType in interface TypeI

Overrides:

toMaybeFunctionType in class JSType

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 class PrototypeObjectType

Returns:

true if this type might be callable.

hasImplementedInterfaces

public boolean hasImplementedInterfaces()

getParameters

public java.lang.Iterable<Node> getParameters()

getParameterTypes

public java.lang.Iterable<TypeI> getParameterTypes()

Specified by:

getParameterTypes in interface FunctionTypeI

getParametersNode

public Node getParametersNode()

Gets a PARAM_LIST node that contains all params. May be null.

getMinArity

public int getMinArity()

Gets the minimum number of arguments that this function requires.

Specified by:

getMinArity in interface FunctionTypeI

getMaxArity

public int getMaxArity()

Gets the maximum number of arguments that this function requires, or Integer.MAX_VALUE if this is a variable argument function.

Specified by:

getMaxArity in interface FunctionTypeI

getReturnType

public JSType getReturnType()

Specified by:

getReturnType in interface FunctionTypeI

isReturnTypeInferred

public boolean isReturnTypeInferred()

getSlot

public Property getSlot(java.lang.String name)

Description copied from class: ObjectType

Default getSlot implementation. This gets overridden by FunctionType for lazily-resolved prototypes.

Overrides:

getSlot in class ObjectType

getOwnPropertyNames

public java.util.Set<java.lang.String> getOwnPropertyNames()

Includes the prototype iff someone has created it. We do not want to expose the prototype for ordinary functions.

Specified by:

getOwnPropertyNames in interface ObjectTypeI

Overrides:

getOwnPropertyNames in class ObjectType

getPrototypeProperty

public ObjectType getPrototypeProperty()

Specified by:

getPrototypeProperty in interface FunctionTypeI

getPrototype

public ObjectType getPrototype()

Gets the prototype property of this function type. This is equivalent to (ObjectType) getPropertyType("prototype").

setPrototypeBasedOn

public void setPrototypeBasedOn(ObjectType baseType)

Sets the prototype, creating the prototype object from the given base type.

Parameters:

baseType - The base type.

extendTemplateTypeMapBasedOn

public void extendTemplateTypeMapBasedOn(ObjectType type)

Extends the TemplateTypeMap of the function's this type, based on the specified type.

Parameters:

type -

explicitlyImplOrExtInterface

public boolean explicitlyImplOrExtInterface(FunctionType interfaceType)

check whether or not this function type has implemented the given interface if this function is an interface, check whether or not this interface has extended the given interface

Parameters:

interfaceType - the interface type

Returns:

true if implemented

getAllImplementedInterfaces

public java.lang.Iterable<ObjectType> getAllImplementedInterfaces()

Returns all interfaces implemented by a class or its superclass and any superclasses for any of those interfaces. If this is called before all types are resolved, it may return an incomplete set.

getAncestorInterfaces

public java.util.Collection<ObjectTypeI> getAncestorInterfaces()

Specified by:

getAncestorInterfaces in interface FunctionTypeI

getImplementedInterfaces

public java.lang.Iterable<ObjectType> getImplementedInterfaces()

Returns interfaces implemented directly by a class or its superclass.

getOwnImplementedInterfaces

public java.lang.Iterable<ObjectType> getOwnImplementedInterfaces()

Returns interfaces directly implemented by the class.

setImplementedInterfaces

public void setImplementedInterfaces(java.util.List<ObjectType> implementedInterfaces)

getExtendedInterfaces

public java.lang.Iterable<ObjectType> getExtendedInterfaces()

Returns interfaces directly extended by an interface

getExtendedInterfacesCount

public int getExtendedInterfacesCount()

Returns the number of interfaces directly extended by an interface

setExtendedInterfaces

public void setExtendedInterfaces(java.util.List<ObjectType> extendedInterfaces)

getPropertyType

public JSType getPropertyType(java.lang.String name)

Description copied from class: ObjectType

Gets the property type of the property whose name is given. If the underlying object does not have this property, the Unknown type is returned to indicate that no information is available on this property. This gets overridden by FunctionType for lazily-resolved call() and bind() functions.

Specified by:

getPropertyType in interface ObjectTypeI

Overrides:

getPropertyType in class ObjectType

Returns:

the property's type or UnknownType. This method never returns null.

getBindReturnType

public FunctionType getBindReturnType(int argsToBind)

Get the return value of calling "bind" on this function with the specified number of arguments.

If -1 is passed, then we will return a result that accepts any parameters.

getSuperClassConstructor

public FunctionType getSuperClassConstructor()

Given a constructor or an interface type, get its superclass constructor or null if none exists.

Specified by:

getSuperClassConstructor in interface ObjectTypeI

Overrides:

getSuperClassConstructor in class ObjectType

getTopMostDefiningType

public ObjectType getTopMostDefiningType(java.lang.String propertyName)

Given a constructor or an interface type and a property, finds the top-most superclass that has the property defined (including this constructor).

hashCode

public int hashCode()

Overrides:

hashCode in class PrototypeObjectType

hasEqualCallType

public boolean hasEqualCallType(FunctionType otherType)

isSubtype

public boolean isSubtype(JSType that)

A function is a subtype of another if their call methods are related via subtyping and this is a subtype of that with regard to the prototype chain.

Overrides:

isSubtype in class PrototypeObjectType

Returns:

this <: that

isSubtype

protected boolean isSubtype(JSType that,
                            com.google.javascript.rhino.jstype.JSType.ImplCache implicitImplCache,
                            JSType.SubtypingMode subtypingMode)

Description copied from class: JSType

checking isSubtype with structural interface matching

Overrides:

isSubtype in class PrototypeObjectType

implicitImplCache - a cache that records the checked or currently checking type pairs, for example, if previous checking found that constructor C is a subtype of interface I, then in the cache, table key <I,C> maps to IMPLEMENT status.

visit

public <T> T visit(Visitor<T> visitor)

Description copied from class: JSType

Visit this type with the given visitor.

Overrides:

visit in class ObjectType

Returns:

the value returned by the visitor

See Also:

Visitor

getInstanceType

public ObjectType getInstanceType()

Gets the type of instance of this function.

Specified by:

getInstanceType in interface FunctionTypeI

Throws:

java.lang.IllegalStateException - if this function is not a constructor (see isConstructor()).

hasInstanceType

public boolean hasInstanceType()

Returns whether this function type has an instance type.

Specified by:

hasInstanceType in interface FunctionTypeI

getTypeOfThis

public JSType getTypeOfThis()

Gets the type of this in this function.

Specified by:

getTypeOfThis in interface FunctionTypeI

Overrides:

getTypeOfThis in class ObjectType

getSource

public Node getSource()

Gets the source node or null if this is an unknown function.

Specified by:

getSource in interface FunctionTypeI

setSource

public void setSource(Node source)

Sets the source node.

Specified by:

setSource in interface FunctionTypeI

clearCachedValues

public void clearCachedValues()

Description copied from class: ObjectType

Clear cached values. Should be called before making changes to a prototype that may have been changed since creation.

Overrides:

clearCachedValues in class ObjectType

getDirectSubTypes

public java.lang.Iterable<FunctionTypeI> getDirectSubTypes()

Description copied from interface: FunctionTypeI

Returns an iterable of direct types that are subtypes of this type. This is only valid for constructors and interfaces, and will not be null. This allows a downward traversal of the subtype graph.

Specified by:

getDirectSubTypes in interface FunctionTypeI

hasCachedValues

public boolean hasCachedValues()

Description copied from class: ObjectType

Returns true if any cached values have been set for this type. If true, then the prototype chain should not be changed, as it might invalidate the cached values.

Overrides:

hasCachedValues in class PrototypeObjectType

toDebugHashCodeString

public java.lang.String toDebugHashCodeString()

Description copied from class: JSType

A hash code function for diagnosing complicated issues around type-identity.

Overrides:

toDebugHashCodeString in class JSType

hasAnyTemplateTypesInternal

public boolean hasAnyTemplateTypesInternal()

convertMethodToFunction

public TypeI convertMethodToFunction()

Description copied from interface: FunctionTypeI

Creates a new function type B based on the original function type A. Takes the receiver type (this type) of A and makes it the first argument of B; B has no receiver type. Used by the DevirtualizePrototypeMethods pass.

Specified by:

convertMethodToFunction in interface FunctionTypeI

hasProperties

public boolean hasProperties()

Description copied from interface: FunctionTypeI

Whether this function type has any properties (not counting "prototype").

Specified by:

hasProperties in interface FunctionTypeI

setImplicitMatch

public void setImplicitMatch(boolean flag)

sets the current interface type to support structural interface matching (abbr. SMI)

Parameters:

flag - indicates whether or not it should support SMI

isStructuralInterface

public boolean isStructuralInterface()

Specified by:

isStructuralInterface in interface TypeI

Overrides:

isStructuralInterface in class JSType

isAbstract

public boolean isAbstract()

getPropertyTypeMap

public java.util.Map<java.lang.String,JSType> getPropertyTypeMap()

get the map of properties to types covered in a function type

Overrides:

getPropertyTypeMap in class ObjectType

Returns:

a Map that maps the property's name to the property's type

checkExtendsLoop

public java.util.List<FunctionType> checkExtendsLoop()

check if there is a loop in the type extends chain

Returns:

an array of all functions in the loop chain if a loop exists, otherwise returns null

checkExtendsLoop

public java.util.List<FunctionType> checkExtendsLoop(java.util.HashSet<FunctionType> cache,
                                                     java.util.List<FunctionType> path)

acceptsArguments

public boolean acceptsArguments(java.util.List<? extends TypeI> argumentTypes)

Description copied from interface: FunctionTypeI

Checks if a call to this function with the given list of arguments is valid.

Specified by:

acceptsArguments in interface FunctionTypeI

toBuilder

public FunctionTypeI.Builder toBuilder()

Description copied from interface: FunctionTypeI

Returns a Builder instance initialized to this function.

Specified by:

toBuilder in interface FunctionTypeI