FunctionType (Closure Compiler v20160208 API)

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, 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 LP 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.TypePair

Field Summary
- Fields inherited from class com.google.javascript.rhino.jstype.JSType
  templateTypeMap

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canBeCalled()` This predicate is used to test whether a given type can be used as the 'function' in a function call.
`List<FunctionType>`	`checkExtendsLoop()` check if there is a loop in the type extends chain
`List<FunctionType>`	`checkExtendsLoop(HashSet<FunctionType> cache, 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.
`FunctionType`	`forgetParameterAndReturnTypes()` Create a new constructor with the parameters and return type stripped.
`Iterable<ObjectType>`	`getAllImplementedInterfaces()` Returns all interfaces implemented by a class or its superclass and any superclasses for any of those interfaces.
`FunctionType`	`getBindReturnType(int argsToBind)` Get the return value of calling "bind" on this function with the specified number of arguments.
`Iterable<ObjectType>`	`getExtendedInterfaces()` Returns interfaces directly extended by an interface
`int`	`getExtendedInterfacesCount()` Returns the number of interfaces directly extended by an interface
`Iterable<ObjectType>`	`getImplementedInterfaces()` Returns interfaces implemented directly by a class or its superclass.
`ObjectType`	`getInstanceType()` Gets the type of instance of this function.
`int`	`getMaxArguments()` Gets the maximum number of arguments that this function requires, or Integer.MAX_VALUE if this is a variable argument function.
`int`	`getMinArguments()` Gets the minimum number of arguments that this function requires.
`Iterable<ObjectType>`	`getOwnImplementedInterfaces()` Returns interfaces directly implemented by the class.
`Set<String>`	`getOwnPropertyNames()` Includes the prototype iff someone has created it.
`Iterable<Node>`	`getParameters()`
`Node`	`getParametersNode()` Gets an LP node that contains all params.
`JSType`	`getPropertyType(String name)` Gets the property type of the property whose name is given.
`Map<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.
`JSType`	`getReturnType()`
`Property`	`getSlot(String name)` Default getSlot implementation.
`Node`	`getSource()` Gets the source node or null if this is an unknown function.
`List<FunctionType>`	`getSubTypes()` Returns a list of types that are subtypes of this type.
`FunctionType`	`getSuperClassConstructor()` Given a constructor or an interface type, get its superclass constructor or `null` if none exists.
`static ObjectType`	`getTopDefiningInterface(ObjectType type, String propertyName)` Given an interface and a property, finds the top-most super interface that has the property defined (including this interface).
`ObjectType`	`getTopMostDefiningType(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()`
`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)` 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(List<ObjectType> extendedInterfaces)`
`void`	`setImplementedInterfaces(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()`
`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.
`protected boolean`	`treatThisTypesAsCovariant(FunctionType other, com.google.javascript.rhino.jstype.JSType.ImplCache implicitImplCache)`
`<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, matchRecordTypeConstraint, removeProperty, setPropertyJSDocInfo, setPropertyNode, unboxesTo

Methods inherited from class com.google.javascript.rhino.jstype.JSType
autobox, autoboxesTo, canCastTo, canTestForEqualityWith, canTestForShallowEqualityWith, collapseUnion, dereference, differsFrom, equals, extendTemplateTypeMap, getGreatestSubtype, getLeastSupertype, getRestrictedTypeGivenToBooleanOutcome, getTemplateTypeMap, getTypesUnderEquality, getTypesUnderInequality, getTypesUnderShallowEquality, getTypesUnderShallowInequality, hasAnyTemplateTypes, hasDisplayName, isAllType, isArrayType, isBooleanObjectType, isBooleanValueType, isBottom, isCheckedUnknownType, isDateType, isDict, isEmptyType, isEnumElementType, isEnumType, isEquivalent, isEquivalentTo, isEquivalentTo, isFunctionType, isGlobalThisType, isNamedType, isNominalConstructor, isNominalType, isNoObjectType, isNoResolvedType, isNoType, isNullable, isNullType, isNumber, isNumberObjectType, isNumberValueType, isRecordType, isRegexpType, isResolved, isString, isStringObjectType, isStringValueType, isStruct, isSubtypeOf, isSubtypeWithoutStructuralTyping, isTemplateType, isTemplatizedType, isUnionType, isVoidable, isVoidType, matchesInt32Context, matchesUint32Context, resolve, restrictByNotNullOrUndefined, setValidator, toAnnotationString, toMaybeEnumElementType, toMaybeEnumType, toMaybeFunctionType, toMaybeNamedType, toMaybeObjectType, toMaybeRecordType, toMaybeTemplateType, toMaybeTemplatizedType, toMaybeUnionType, toNonNullAnnotationString, toObjectType, toString

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.TypeI
isBottom, isEquivalentTo, isFunctionType, isSubtypeOf, isUnknownType, restrictByNotNullOrUndefined, toMaybeObjectType

- 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.
    
    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
  - 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 Iterable<Node> getParameters()
```
  - getParametersNode
```
public Node getParametersNode()
```
    Gets an LP node that contains all params. May be null.
  - getMinArguments
```
public int getMinArguments()
```
    Gets the minimum number of arguments that this function requires.
  - getMaxArguments
```
public int getMaxArguments()
```
    Gets the maximum number of arguments that this function requires, or Integer.MAX_VALUE if this is a variable argument function.
  - getReturnType
```
public JSType getReturnType()
```
  - isReturnTypeInferred
```
public boolean isReturnTypeInferred()
```
  - getSlot
```
public Property getSlot(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 Set<String> getOwnPropertyNames()
```
    Includes the prototype iff someone has created it. We do not want to expose the prototype for ordinary functions.
    
    Overrides:
    
    getOwnPropertyNames in class ObjectType
  - 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 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.
  - getImplementedInterfaces
```
public Iterable<ObjectType> getImplementedInterfaces()
```
    Returns interfaces implemented directly by a class or its superclass.
  - getOwnImplementedInterfaces
```
public Iterable<ObjectType> getOwnImplementedInterfaces()
```
    Returns interfaces directly implemented by the class.
  - setImplementedInterfaces
```
public void setImplementedInterfaces(List<ObjectType> implementedInterfaces)
```
  - getExtendedInterfaces
```
public 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(List<ObjectType> extendedInterfaces)
                           throws UnsupportedOperationException
```
    Throws:
    
    UnsupportedOperationException
  - getPropertyType
```
public JSType getPropertyType(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.
    
    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.
  - getTopDefiningInterface
```
public static ObjectType getTopDefiningInterface(ObjectType type,
                                                 String propertyName)
```
    Given an interface and a property, finds the top-most super interface that has the property defined (including this interface).
  - getTopMostDefiningType
```
public ObjectType getTopMostDefiningType(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 JSType
  - 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)
```
    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.
  - treatThisTypesAsCovariant
```
protected boolean treatThisTypesAsCovariant(FunctionType other,
                                            com.google.javascript.rhino.jstype.JSType.ImplCache implicitImplCache)
```
  - 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:
    
    IllegalStateException - if this function is not a constructor (see isConstructor()).
  - hasInstanceType
```
public boolean hasInstanceType()
```
    Returns whether this function type has an instance type.
  - 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
  - getSubTypes
```
public List<FunctionType> getSubTypes()
```
    Returns a list of types that are subtypes of this type. This is only valid for constructor functions, and may be null. This allows a downward traversal of the subtype graph.
    
    Specified by:
    
    getSubTypes 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 String toDebugHashCodeString()
```
    Description copied from class: JSType
    
    A hash code function for diagnosing complicated issues around type-identity.
    
    Overrides:
    
    toDebugHashCodeString in class JSType
  - forgetParameterAndReturnTypes
```
public FunctionType forgetParameterAndReturnTypes()
```
    Create a new constructor with the parameters and return type stripped.
  - 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()
```
    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()
```
    Overrides:
    
    isStructuralInterface in class JSType
  - getPropertyTypeMap
```
public Map<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 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 List<FunctionType> checkExtendsLoop(HashSet<FunctionType> cache,
                                           List<FunctionType> path)
```

Class FunctionType

Nested Class Summary

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

Field Summary

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

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

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

Method Detail

isInstanceType

isConstructor

isInterface

isOrdinaryFunction

makesStructs

makesDicts

setStruct

setDict

toMaybeFunctionType

canBeCalled

hasImplementedInterfaces

getParameters

getParametersNode

getMinArguments

getMaxArguments

getReturnType

isReturnTypeInferred

getSlot

getOwnPropertyNames

getPrototype

setPrototypeBasedOn

extendTemplateTypeMapBasedOn

explicitlyImplOrExtInterface

getAllImplementedInterfaces

getImplementedInterfaces

getOwnImplementedInterfaces

setImplementedInterfaces

getExtendedInterfaces

getExtendedInterfacesCount

setExtendedInterfaces

getPropertyType

getBindReturnType

getSuperClassConstructor

getTopDefiningInterface

getTopMostDefiningType

hashCode

hasEqualCallType

isSubtype

isSubtype

treatThisTypesAsCovariant

visit

getInstanceType

hasInstanceType

getTypeOfThis

getSource

setSource

clearCachedValues

getSubTypes

hasCachedValues

toDebugHashCodeString

forgetParameterAndReturnTypes

hasAnyTemplateTypesInternal

convertMethodToFunction

hasProperties

setImplicitMatch

isStructuralInterface

getPropertyTypeMap

checkExtendsLoop

checkExtendsLoop