FunctionType (Closure Compiler Unshaded v20170626 API)

java.lang.Object
- com.google.javascript.jscomp.newtypes.FunctionType

All Implemented Interfaces:

Serializable
```
public final class FunctionType
extends Object
implements Serializable
```
Additional type information for methods and stand-alone functions. Stored as a field in appropriate ObjectType instances.

Author:

blickly@google.com (Ben Lickly), dimvar@google.com (Dimitris Vardoulakis)

See Also:

Serialized Form

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`FunctionType`	`transformByApply` Returns a FunctionType representing the 'apply' property of this function.
`FunctionType`	`transformByCall` Returns a FunctionType representing the 'call' property of this function (i.e.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StringBuilder`	`appendTo(StringBuilder builder, ToStringContext ctx)`
`boolean`	`equals(Object obj)`
`JSType`	`getFormalType(int argpos)` Returns the formal parameter in the given (0-indexed) position, or null if the position is past the end of the parameter list.
`JSType`	`getInstanceTypeOfCtor()` If this type is a constructor (e.g.
`int`	`getMaxArity()` Returns the maximum number of parameters accepted by this function, or Integer.MAX_VALUE for a function with rest parameters (effectively infinite).
`int`	`getMaxArityWithoutRestFormals()` Returns the maximum number of parameters accepted by this function, not counting rest parameters.
`int`	`getMinArity()` Returns the minimum number of parameters accepted by this function.
`JSType`	`getOuterVarPrecondition(String name)` Returns the type of the closed-over variable of the given name, or null if the named variable is not in the closure.
`JSType`	`getRestFormalsType()` Returns the type of this function's rest parameter.
`JSType`	`getReturnType()`
`JSType`	`getSuperPrototype()` Returns the prototype object of the superclass, or null if there is no superclass.
`JSType`	`getThisType()` Returns the 'this' type of the function, or the 'new' type for a constructor.
`List<String>`	`getTypeParameters()` Returns all the non-instantiated type parameter names.
`int`	`hashCode()`
`boolean`	`hasRestFormals()`
`FunctionType`	`instantiateGenerics(Map<String,JSType> typeMap)` Returns a FunctionType with generic type parameters instantiated as concrete types using typeMap.
`FunctionType`	`instantiateGenericsFromArgumentTypes(JSType recvtype, List<JSType> argTypes)` Given concrete types for the arguments, unify with the formals to create a type map, and then instantiate this function as usual, by calling `substituteParametricGenerics(java.util.Map<java.lang.String, com.google.javascript.jscomp.newtypes.JSType>)`.
`boolean`	`isAbstract()`
`boolean`	`isConstructorOfAbstractClass()`
`boolean`	`isGeneric()` Returns true if this function has any non-instantiated type parameters.
`boolean`	`isInterfaceDefinition()` Returns true if this is a constructor for a single interface, i.e.
`boolean`	`isLoose()` Returns true if this function type is "loose".
`boolean`	`isOptionalArg(int i)` Returns true if the `i`th parameter is an optional parameter.
`boolean`	`isQmarkFunction()` Returns true if this function is the common QMARK_FUNCTION type (function(...?): ?), determined by reference equality.
`boolean`	`isRequiredArg(int i)` Returns true if the `i`th parameter is required.
`boolean`	`isSomeConstructorOrInterface()` Returns true if this type is some sort of constructor, i.e.
`boolean`	`isTopFunction()` Returns true if this function is either version (loose or not) of the top function (which takes all bottoms and returns top).
`boolean`	`isUniqueConstructor()` Returns true if this is a constructor for a single class, i.e.
`boolean`	`isValidOverride(FunctionType other)` Returns true if this function is a valid override of other.
`DeclaredFunctionType`	`toDeclaredFunctionType()` Returns this function type as a `DeclaredFunctionType`.
`String`	`toString()`
`FunctionType`	`transformByApplyProperty()` Returns a FunctionType representing the 'apply' property of this function.
`FunctionType`	`transformByCallProperty()` Returns a FunctionType representing the 'call' property of this function (i.e.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Property Detail
  - transformByCall
```
public FunctionType transformByCallProperty
```
    Returns a FunctionType representing the 'call' property of this function (i.e. the receiver type is prepended to the parameter list).
  - transformByApply
```
public FunctionType transformByApplyProperty
```
    Returns a FunctionType representing the 'apply' property of this function. In most cases, only the receiver type is checked, since heterogeneous parameter types are not representable without tuples in the type system (or other special handling). If the only parameter is a rest parameter, then the array argument is typed correctly.
- Method Detail
  - isLoose
```
public boolean isLoose()
```
    Returns true if this function type is "loose". When an unannotated formal parameter of some function is itself used as a function, we infer a loose function type for it. For example: function f(g) { return g(5) - 2; }. Here, g is a loose number→number function. A loose function type may have required formal parameters that are bottom.
  - isAbstract
```
public boolean isAbstract()
```
  - isConstructorOfAbstractClass
```
public boolean isConstructorOfAbstractClass()
```
  - isTopFunction
```
public boolean isTopFunction()
```
    Returns true if this function is either version (loose or not) of the top function (which takes all bottoms and returns top).
  - isSomeConstructorOrInterface
```
public boolean isSomeConstructorOrInterface()
```
    Returns true if this type is some sort of constructor, i.e. function(new: T) for any value of T (whether it be a class, interface, type variable, or union thereof). This is a looser version of isUniqueConstructor() and isInterfaceDefinition().
  - isUniqueConstructor
```
public boolean isUniqueConstructor()
```
    Returns true if this is a constructor for a single class, i.e. function(new: Foo} where Foo is a concrete class.
  - isInterfaceDefinition
```
public boolean isInterfaceDefinition()
```
    Returns true if this is a constructor for a single interface, i.e. function(new: Foo} where Foo is an interface definition.
  - getSuperPrototype
```
public JSType getSuperPrototype()
```
    Returns the prototype object of the superclass, or null if there is no superclass.
    
    Throws:
    
    IllegalStateException - if this is not a unique constructor.
  - isQmarkFunction
```
public boolean isQmarkFunction()
```
    Returns true if this function is the common QMARK_FUNCTION type (function(...?): ?), determined by reference equality.
  - hasRestFormals
```
public boolean hasRestFormals()
```
  - getRestFormalsType
```
public JSType getRestFormalsType()
```
    Returns the type of this function's rest parameter.
    
    Throws:
    
    IllegalStateException - if there is no rest parameter.
  - getFormalType
```
public JSType getFormalType(int argpos)
```
    Returns the formal parameter in the given (0-indexed) position, or null if the position is past the end of the parameter list.
    
    Throws:
    
    IllegalStateException - if this is the top function (rather than returning bottom).
  - getReturnType
```
public JSType getReturnType()
```
  - getOuterVarPrecondition
```
public JSType getOuterVarPrecondition(String name)
```
    Returns the type of the closed-over variable of the given name, or null if the named variable is not in the closure.
    
    Throws:
    
    IllegalStateException - if this is the top function.
  - getMinArity
```
public int getMinArity()
```
    Returns the minimum number of parameters accepted by this function.
    
    Throws:
    
    IllegalStateException - if this is the top function, which has effectively-infinite minimum arity.
  - getMaxArity
```
public int getMaxArity()
```
    Returns the maximum number of parameters accepted by this function, or Integer.MAX_VALUE for a function with rest parameters (effectively infinite).
    
    Throws:
    
    IllegalStateException - if this is the top function.
  - getMaxArityWithoutRestFormals
```
public int getMaxArityWithoutRestFormals()
```
    Returns the maximum number of parameters accepted by this function, not counting rest parameters.
    
    Throws:
    
    IllegalStateException - if this is the top function.
  - isRequiredArg
```
public boolean isRequiredArg(int i)
```
    Returns true if the ith parameter is required.
  - isOptionalArg
```
public boolean isOptionalArg(int i)
```
    Returns true if the ith parameter is an optional parameter.
  - getInstanceTypeOfCtor
```
public JSType getInstanceTypeOfCtor()
```
    If this type is a constructor (e.g. function(new: Foo)), returns the type Foo. If the nominal type is generic, then type parameters are set to unknown. Returns null for non-constructors.
  - getThisType
```
public JSType getThisType()
```
    Returns the 'this' type of the function, or the 'new' type for a constructor.
  - transformByCallProperty
```
public FunctionType transformByCallProperty()
```
    Returns a FunctionType representing the 'call' property of this function (i.e. the receiver type is prepended to the parameter list).
  - transformByApplyProperty
```
public FunctionType transformByApplyProperty()
```
    Returns a FunctionType representing the 'apply' property of this function. In most cases, only the receiver type is checked, since heterogeneous parameter types are not representable without tuples in the type system (or other special handling). If the only parameter is a rest parameter, then the array argument is typed correctly.
  - toDeclaredFunctionType
```
public DeclaredFunctionType toDeclaredFunctionType()
```
    Returns this function type as a DeclaredFunctionType. While DeclaredFunctionType allows incomplete types (i.e. null formals or returns), this function always returns a complete type. This should only be called from GlobalTypeInfo.
    
    Throws:
    
    IllegalStateException - if this function is loose.
  - isValidOverride
```
public boolean isValidOverride(FunctionType other)
```
    Returns true if this function is a valid override of other. Specifically, this requires that this function be a subtype of other.
  - isGeneric
```
public boolean isGeneric()
```
    Returns true if this function has any non-instantiated type parameters. (Note: if this type is the result of a generic function type that has been instantiated, the type parameters have already been substituted away.)
  - getTypeParameters
```
public List<String> getTypeParameters()
```
    Returns all the non-instantiated type parameter names. (Note: if this type is the result of a generic function type that has been instantiated, the type parameters have already been substituted away.)
  - instantiateGenerics
```
public FunctionType instantiateGenerics(Map<String,JSType> typeMap)
```
    Returns a FunctionType with generic type parameters instantiated as concrete types using typeMap. This is an orthogonal operation to substituteNominalGenerics(java.util.Map<java.lang.String, com.google.javascript.jscomp.newtypes.JSType>), which operates on the free type variables found in formal parameters and returns.
  - instantiateGenericsFromArgumentTypes
```
public FunctionType instantiateGenericsFromArgumentTypes(JSType recvtype,
                                                         List<JSType> argTypes)
```
    Given concrete types for the arguments, unify with the formals to create a type map, and then instantiate this function as usual, by calling substituteParametricGenerics(java.util.Map<java.lang.String, com.google.javascript.jscomp.newtypes.JSType>).
    
    Throws:
    
    IllegalStateException - if this is not a generic function.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - appendTo
```
public StringBuilder appendTo(StringBuilder builder,
                              ToStringContext ctx)
```

Class FunctionType

Property Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

transformByCall

transformByApply

Method Detail

isLoose

isAbstract

isConstructorOfAbstractClass

isTopFunction

isSomeConstructorOrInterface

isUniqueConstructor

isInterfaceDefinition

getSuperPrototype

isQmarkFunction

hasRestFormals

getRestFormalsType

getFormalType

getReturnType

getOuterVarPrecondition

getMinArity

getMaxArity

getMaxArityWithoutRestFormals

isRequiredArg

isOptionalArg

getInstanceTypeOfCtor

getThisType

transformByCallProperty

transformByApplyProperty

toDeclaredFunctionType

isValidOverride

isGeneric

getTypeParameters

instantiateGenerics

instantiateGenericsFromArgumentTypes

equals

hashCode

toString

appendTo