com.google.javascript.jscomp.newtypes

Class FunctionTypeBuilder

java.lang.Object

com.google.javascript.jscomp.newtypes.FunctionTypeBuilder

public final class FunctionTypeBuilder
extends Object

A builder for FunctionType and DeclaredFunctionType. The builder is called during both JSDoc parsing and type inference, and these parts use different warning systems, so expect the context to handle the exception appropriately.

Author:

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

Constructor Summary

Constructors

Constructor and Description
FunctionTypeBuilder()

Method Summary

Modifier and Type	Method and Description
FunctionTypeBuilder	addLoose()
FunctionTypeBuilder	addNominalType(NominalType cl)
FunctionTypeBuilder	addOptFormal(JSType t)
FunctionTypeBuilder	addOuterVarPrecondition(String name, JSType t)
FunctionTypeBuilder	addPlaceholderFormal() Used when the order of required/optional/rest formals in a function jsdoc is wrong.
FunctionTypeBuilder	addReceiverType(NominalType cl)
FunctionTypeBuilder	addReqFormal(JSType t)
FunctionTypeBuilder	addRestFormals(JSType t)
FunctionTypeBuilder	addRetType(JSType t)
FunctionTypeBuilder	addTypeParameters(com.google.common.collect.ImmutableList<String> typeParameters)
DeclaredFunctionType	buildDeclaration()
FunctionType	buildFunction()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FunctionTypeBuilder

public FunctionTypeBuilder()

Method Detail

addPlaceholderFormal

public FunctionTypeBuilder addPlaceholderFormal()

Used when the order of required/optional/rest formals in a function jsdoc is wrong.

addReqFormal

public FunctionTypeBuilder addReqFormal(JSType t)
                                 throws com.google.javascript.jscomp.newtypes.FunctionTypeBuilder.WrongParameterOrderException

Throws:

com.google.javascript.jscomp.newtypes.FunctionTypeBuilder.WrongParameterOrderException

addOptFormal

public FunctionTypeBuilder addOptFormal(JSType t)
                                 throws com.google.javascript.jscomp.newtypes.FunctionTypeBuilder.WrongParameterOrderException

Throws:

com.google.javascript.jscomp.newtypes.FunctionTypeBuilder.WrongParameterOrderException

addOuterVarPrecondition

public FunctionTypeBuilder addOuterVarPrecondition(String name,
                                                   JSType t)

addRestFormals

public FunctionTypeBuilder addRestFormals(JSType t)

addRetType

public FunctionTypeBuilder addRetType(JSType t)

addLoose

public FunctionTypeBuilder addLoose()

addNominalType

public FunctionTypeBuilder addNominalType(NominalType cl)

addTypeParameters

public FunctionTypeBuilder addTypeParameters(com.google.common.collect.ImmutableList<String> typeParameters)

addReceiverType

public FunctionTypeBuilder addReceiverType(NominalType cl)

buildDeclaration

public DeclaredFunctionType buildDeclaration()

buildFunction

public FunctionType buildFunction()