com.google.javascript.rhino.jstype

Class FunctionBuilder

java.lang.Object

com.google.javascript.rhino.jstype.FunctionBuilder

public final class FunctionBuilder
extends java.lang.Object

A builder class for function and arrow types. If you need to build an interface constructor, use JSTypeRegistry.createInterfaceType(java.lang.String, com.google.javascript.rhino.Node, com.google.common.collect.ImmutableList<com.google.javascript.rhino.jstype.TemplateType>, boolean).

Author:

nicksantos@google.com (Nick Santos)

Constructor Summary

Constructors

Constructor and Description
FunctionBuilder(JSTypeRegistry registry)

Method Summary

Modifier and Type	Method and Description
FunctionType	build() Construct a new function type.
FunctionBuilder	copyFromOtherFunction(FunctionType otherType) Copies all the information from another function type.
FunctionBuilder	forConstructor() Make this a constructor.
FunctionBuilder	forInterface() Make this an interface.
FunctionBuilder	withConstructorTemplateKeys(java.lang.Iterable<TemplateType> constructorOnlyKeys) Specifies a subset of the template keys that only apply to the constructor, and should be removed from the instance type.
FunctionBuilder	withInferredReturnType(JSType returnType) Sets an inferred return type.
FunctionBuilder	withIsAbstract(boolean isAbstract) Mark abstract method.
FunctionBuilder	withName(java.lang.String name) Set the name of the function type.
FunctionBuilder	withParamsNode(Node parametersNode) Set the parameters of the function type with a specially-formatted node.
FunctionBuilder	withPrototypeBasedOn(ObjectType setPrototypeBasedOn) Set the prototype property of a constructor.
FunctionBuilder	withReturnType(JSType returnType) Set the return type.
FunctionBuilder	withReturnType(JSType returnType, boolean inferred) Set the return type and whether it's inferred.
FunctionBuilder	withSourceNode(Node sourceNode) Set the source node of the function type.
FunctionBuilder	withTemplateKeys(com.google.common.collect.ImmutableList<TemplateType> templateKeys) Set the template name.
FunctionBuilder	withTemplateKeys(TemplateType... templateKeys) Set the template name.
FunctionBuilder	withTypeOfThis(JSType typeOfThis) Set the "this" type.

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionBuilder

public FunctionBuilder(JSTypeRegistry registry)

Method Detail

withName

public FunctionBuilder withName(java.lang.String name)

Set the name of the function type.

withSourceNode

public FunctionBuilder withSourceNode(Node sourceNode)

Set the source node of the function type.

withParamsNode

public FunctionBuilder withParamsNode(Node parametersNode)

Set the parameters of the function type with a specially-formatted node.

withReturnType

public FunctionBuilder withReturnType(JSType returnType)

Set the return type.

withReturnType

public FunctionBuilder withReturnType(JSType returnType,
                                      boolean inferred)

Set the return type and whether it's inferred.

withInferredReturnType

public FunctionBuilder withInferredReturnType(JSType returnType)

Sets an inferred return type.

withTypeOfThis

public FunctionBuilder withTypeOfThis(JSType typeOfThis)

Set the "this" type.

withTemplateKeys

public FunctionBuilder withTemplateKeys(com.google.common.collect.ImmutableList<TemplateType> templateKeys)

Set the template name.

withTemplateKeys

public FunctionBuilder withTemplateKeys(TemplateType... templateKeys)

Set the template name.

withConstructorTemplateKeys

public FunctionBuilder withConstructorTemplateKeys(java.lang.Iterable<TemplateType> constructorOnlyKeys)

Specifies a subset of the template keys that only apply to the constructor, and should be removed from the instance type. These keys must still be passed to withTemplateKeys(com.google.common.collect.ImmutableList<com.google.javascript.rhino.jstype.TemplateType>).

forConstructor

public FunctionBuilder forConstructor()

Make this a constructor.

forInterface

public FunctionBuilder forInterface()

Make this an interface.

withIsAbstract

public FunctionBuilder withIsAbstract(boolean isAbstract)

Mark abstract method.

withPrototypeBasedOn

public FunctionBuilder withPrototypeBasedOn(ObjectType setPrototypeBasedOn)

Set the prototype property of a constructor.

copyFromOtherFunction

public FunctionBuilder copyFromOtherFunction(FunctionType otherType)

Copies all the information from another function type.

build

public FunctionType build()

Construct a new function type.