com.google.javascript.rhino.jstype

Class UnionTypeBuilder

java.lang.Object

com.google.javascript.rhino.jstype.UnionTypeBuilder

All Implemented Interfaces:

java.io.Serializable

public final class UnionTypeBuilder
extends java.lang.Object
implements java.io.Serializable

A builder for union types.

Author:

nicksantos@google.com (Nick Santos)

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
UnionTypeBuilder	addAlternate(JSType alternate) Adds an alternate to the union type under construction.
JSType	build() Creates a union.
static UnionTypeBuilder	create(JSTypeRegistry registry)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static UnionTypeBuilder create(JSTypeRegistry registry)

addAlternate

public UnionTypeBuilder addAlternate(JSType alternate)

Adds an alternate to the union type under construction.

Returns this for easy chaining.

TODO(nickreid): This method shouldn't eagerly collapse types. Doing so risks holding onto a nested union if an alternate resolves so a union after being added. We should do use some technique to determine if the builder has become dirty and caching the result of `build()` until then.

build

public JSType build()

Creates a union.

Returns:

A UnionType if it has two or more alternates, the only alternate if it has one and otherwise NO_TYPE.