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(JSTypes commonTypes)

Method Summary

Modifier and Type	Method and Description
FunctionTypeBuilder	addAbstract(boolean isAbstract)
FunctionTypeBuilder	addLoose()
FunctionTypeBuilder	addNominalType(JSType t)
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(JSType t)
FunctionTypeBuilder	addReqFormal(JSType t)
FunctionTypeBuilder	addReqFormalToFront(JSType t)
FunctionTypeBuilder	addRestFormals(JSType t)
FunctionTypeBuilder	addRetType(JSType t)
FunctionTypeBuilder	addTypeParameters(com.google.common.collect.ImmutableList<String> typeParameters)
FunctionTypeBuilder	appendTypeParameters(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(JSTypes commonTypes)

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)

addReqFormalToFront

public FunctionTypeBuilder addReqFormalToFront(JSType t)

addOptFormal

public FunctionTypeBuilder addOptFormal(JSType t)

addOuterVarPrecondition

public FunctionTypeBuilder addOuterVarPrecondition(String name,
                                                   JSType t)

addRestFormals

public FunctionTypeBuilder addRestFormals(JSType t)

addRetType

public FunctionTypeBuilder addRetType(JSType t)

addLoose

public FunctionTypeBuilder addLoose()

addAbstract

public FunctionTypeBuilder addAbstract(boolean isAbstract)

addNominalType

public FunctionTypeBuilder addNominalType(JSType t)

addTypeParameters

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

appendTypeParameters

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

addReceiverType

public FunctionTypeBuilder addReceiverType(JSType t)

buildDeclaration

public DeclaredFunctionType buildDeclaration()

buildFunction

public FunctionType buildFunction()