JSType (Closure Compiler v20150505 API)

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

All Implemented Interfaces:

TypeI
```
public abstract class JSType
extends Object
implements TypeI
```
Author:

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

Field Summary

Fields
Modifier and Type	Field and Description
`static JSType`	`BOOLEAN`
`protected static int`	`BOOLEAN_MASK`
`static JSType`	`BOTTOM`
`protected static int`	`BOTTOM_MASK`
`protected static int`	`END_MASK`
`protected static int`	`ENUM_MASK`
`protected static int`	`FALSE_MASK`
`static JSType`	`FALSE_TYPE`
`static JSType`	`FALSY`
`protected static int`	`FALSY_MASK`
`static boolean`	`mockToString`
`protected static int`	`NON_SCALAR_MASK`
`static JSType`	`NULL`
`protected static int`	`NULL_MASK`
`static JSType`	`NULL_OR_UNDEF`
`static JSType`	`NUM_OR_STR`
`static JSType`	`NUMBER`
`protected static int`	`NUMBER_MASK`
`static JSType`	`STRING`
`protected static int`	`STRING_MASK`
`static JSType`	`TOP`
`static JSType`	`TOP_DICT`
`protected static int`	`TOP_MASK`
`static JSType`	`TOP_OBJECT`
`static JSType`	`TOP_SCALAR`
`protected static int`	`TOP_SCALAR_MASK`
`static JSType`	`TOP_STRUCT`
`protected static int`	`TRUE_MASK`
`static JSType`	`TRUE_TYPE`
`static JSType`	`TRUTHY`
`protected static int`	`TRUTHY_MASK`
`protected static int`	`TYPEVAR_MASK`
`static JSType`	`UNDEFINED`
`protected static int`	`UNDEFINED_MASK`
`static JSType`	`UNKNOWN`
`protected static int`	`UNKNOWN_MASK`

Constructor Summary

Constructors
Constructor and Description

JSType()

Constructors
Constructor and Description
`JSType()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`StringBuilder`	`appendTo(StringBuilder builder)`
`static boolean`	`areCompatibleScalarTypes(JSType lhs, JSType rhs)`
`JSType`	`autobox(JSTypes commonTypes)`
`boolean`	`equals(Object o)`
`static JSType`	`fromObjectType(ObjectType obj)`
`static JSType`	`fromTypeVar(String typevarName)`
`Collection<JSType>`	`getAlternates()`
`JSType`	`getDeclaredProp(QualifiedName qname)`
`JSType`	`getEnumeratedType()`
`protected abstract com.google.common.collect.ImmutableSet<EnumType>`	`getEnums()`
`FunctionType`	`getFunType()`
`FunctionType`	`getFunTypeIfSingletonObj()`
`protected abstract int`	`getMask()`
`NominalType`	`getNominalTypeIfSingletonObj()`
`ObjectType`	`getObjectTypeIfSingletonObj()`
`JSType`	`getProp(QualifiedName qname)`
`protected abstract String`	`getTypeVar()`
`boolean`	`hasConstantProp(QualifiedName pname)`
`int`	`hashCode()`
`boolean`	`hasNonScalar()`
`boolean`	`hasProp(QualifiedName qname)`
`boolean`	`isBoolean()`
`boolean`	`isBottom()`
`boolean`	`isConstructor()`
`boolean`	`isDict()`
`boolean`	`isEnumElement()`
`boolean`	`isEquivalentTo(TypeI type)`
`boolean`	`isFalsy()`
`boolean`	`isFunctionType()`
`boolean`	`isInterface()`
`boolean`	`isInterfaceDefinition()`
`boolean`	`isLoose()`
`boolean`	`isLooseStruct()`
`boolean`	`isNonLooseSubtypeOf(JSType other)`
`boolean`	`isNullable()`
`boolean`	`isNullOrUndef()`
`boolean`	`isNumber()`
`boolean`	`isScalar()`
`boolean`	`isString()`
`boolean`	`isStruct()`
`boolean`	`isSubtypeOf(TypeI other)`
`boolean`	`isTop()`
`boolean`	`isTruthy()`
`boolean`	`isTypeVariable()`
`boolean`	`isUnion()`
`boolean`	`isUnknown()`
`boolean`	`isUnknownType()`
`static JSType`	`join(JSType lhs, JSType rhs)`
`boolean`	`mayHaveProp(QualifiedName qname)`
`static JSType`	`meet(JSType lhs, JSType rhs)`
`JSType`	`negate()`
`static JSType`	`plus(JSType lhs, JSType rhs)`
`JSType`	`removeType(JSType other)`
`TypeI`	`restrictByNotNullOrUndefined()`
`JSType`	`specialize(JSType other)`
`JSType`	`substituteGenerics(Map<String,JSType> concreteTypes)`
`JSType`	`substituteGenericsWithUnknown()`
`JSType`	`toBoolean()`
`FunctionTypeI`	`toMaybeFunctionType()`
`ObjectTypeI`	`toMaybeObjectType()`
`String`	`toString()`
`boolean`	`unifyWithSubtype(JSType other, List<String> typeParameters, com.google.common.collect.Multimap<String,JSType> typeMultimap)` Unify `this`, which may contain free type variables, with `other`, a concrete subtype, modifying the supplied `typeMultimap` to add any new template variable type bindings.
`JSType`	`withDeclaredProperty(QualifiedName qname, JSType type, boolean isConstant)`
`JSType`	`withLoose()` Turns the class-less object of this type (if any) into a loose object
`JSType`	`withoutProperty(QualifiedName qname)`
`JSType`	`withProperty(QualifiedName qname, JSType type)`
`JSType`	`withPropertyRequired(String pname)`

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

Field Detail

BOTTOM_MASK
```
protected static final int BOTTOM_MASK
```
See Also:

Constant Field Values

TYPEVAR_MASK
```
protected static final int TYPEVAR_MASK
```
See Also:

Constant Field Values

NON_SCALAR_MASK
```
protected static final int NON_SCALAR_MASK
```
See Also:

Constant Field Values

ENUM_MASK
```
protected static final int ENUM_MASK
```
See Also:

Constant Field Values

TRUE_MASK
```
protected static final int TRUE_MASK
```
See Also:

Constant Field Values

FALSE_MASK
```
protected static final int FALSE_MASK
```
See Also:

Constant Field Values

NULL_MASK
```
protected static final int NULL_MASK
```
See Also:

Constant Field Values

NUMBER_MASK
```
protected static final int NUMBER_MASK
```
See Also:

Constant Field Values

STRING_MASK
```
protected static final int STRING_MASK
```
See Also:

Constant Field Values

UNDEFINED_MASK
```
protected static final int UNDEFINED_MASK
```
See Also:

Constant Field Values

END_MASK
```
protected static final int END_MASK
```
See Also:

Constant Field Values

TRUTHY_MASK
```
protected static final int TRUTHY_MASK
```
See Also:

Constant Field Values

FALSY_MASK
```
protected static final int FALSY_MASK
```
See Also:

Constant Field Values

UNKNOWN_MASK
```
protected static final int UNKNOWN_MASK
```
See Also:

Constant Field Values

TOP_MASK
```
protected static final int TOP_MASK
```
See Also:

Constant Field Values

BOOLEAN_MASK
```
protected static final int BOOLEAN_MASK
```
See Also:

Constant Field Values

TOP_SCALAR_MASK
```
protected static final int TOP_SCALAR_MASK
```
See Also:

Constant Field Values

mockToString
```
public static boolean mockToString
```

BOOLEAN
```
public static final JSType BOOLEAN
```

BOTTOM
```
public static final JSType BOTTOM
```

FALSE_TYPE
```
public static final JSType FALSE_TYPE
```

FALSY
```
public static final JSType FALSY
```

NULL
```
public static final JSType NULL
```

NUMBER
```
public static final JSType NUMBER
```

STRING
```
public static final JSType STRING
```

TOP
```
public static final JSType TOP
```

TOP_SCALAR
```
public static final JSType TOP_SCALAR
```

TRUE_TYPE
```
public static final JSType TRUE_TYPE
```

TRUTHY
```
public static final JSType TRUTHY
```

UNDEFINED
```
public static final JSType UNDEFINED
```

UNKNOWN
```
public static final JSType UNKNOWN
```

TOP_OBJECT
```
public static final JSType TOP_OBJECT
```

TOP_STRUCT
```
public static final JSType TOP_STRUCT
```

TOP_DICT
```
public static final JSType TOP_DICT
```

NULL_OR_UNDEF

public static final JSType NULL_OR_UNDEF

NUM_OR_STR
```
public static final JSType NUM_OR_STR
```

Constructor Detail
- JSType
```
public JSType()
```

Method Detail

getMask
```
protected abstract int getMask()
```

getTypeVar

protected abstract String getTypeVar()

getEnums

protected abstract com.google.common.collect.ImmutableSet<EnumType> getEnums()

getAlternates

public Collection<JSType> getAlternates()

fromObjectType

public static JSType fromObjectType(ObjectType obj)

fromTypeVar

public static JSType fromTypeVar(String typevarName)

isTop
```
public boolean isTop()
```

isBottom
```
public boolean isBottom()
```
Specified by:

isBottom in interface TypeI

isUnknown
```
public boolean isUnknown()
```

isTruthy
```
public boolean isTruthy()
```

isFalsy
```
public boolean isFalsy()
```

isBoolean
```
public boolean isBoolean()
```

isString
```
public boolean isString()
```

isNumber
```
public boolean isNumber()
```

isNullOrUndef
```
public boolean isNullOrUndef()
```

isScalar
```
public boolean isScalar()
```

hasNonScalar
```
public boolean hasNonScalar()
```

isNullable
```
public boolean isNullable()
```

isTypeVariable
```
public boolean isTypeVariable()
```

isStruct
```
public boolean isStruct()
```

isLooseStruct
```
public boolean isLooseStruct()
```

isLoose
```
public boolean isLoose()
```

isDict
```
public boolean isDict()
```

isEnumElement
```
public boolean isEnumElement()
```

isUnion
```
public boolean isUnion()
```

areCompatibleScalarTypes

public static boolean areCompatibleScalarTypes(JSType lhs,
                                               JSType rhs)

getEnumeratedType
```
public JSType getEnumeratedType()
```

autobox

public JSType autobox(JSTypes commonTypes)

join

public static JSType join(JSType lhs,
                          JSType rhs)

substituteGenerics

public JSType substituteGenerics(Map<String,JSType> concreteTypes)

substituteGenericsWithUnknown

public JSType substituteGenericsWithUnknown()

unifyWithSubtype
```
public boolean unifyWithSubtype(JSType other,
                                List<String> typeParameters,
                                com.google.common.collect.Multimap<String,JSType> typeMultimap)
```
Unify this, which may contain free type variables, with other, a concrete subtype, modifying the supplied typeMultimap to add any new template variable type bindings. Note that if this is a union type, some of the union members may be ignored if they are not present in other.

Returns:

Whether unification succeeded

specialize

public JSType specialize(JSType other)

meet

public static JSType meet(JSType lhs,
                          JSType rhs)

plus

public static JSType plus(JSType lhs,
                          JSType rhs)

negate
```
public JSType negate()
```

toBoolean
```
public JSType toBoolean()
```

isNonLooseSubtypeOf

public boolean isNonLooseSubtypeOf(JSType other)

isSubtypeOf
```
public boolean isSubtypeOf(TypeI other)
```
Specified by:

isSubtypeOf in interface TypeI

removeType

public JSType removeType(JSType other)

getFunTypeIfSingletonObj

public FunctionType getFunTypeIfSingletonObj()

getFunType
```
public FunctionType getFunType()
```

getNominalTypeIfSingletonObj

public NominalType getNominalTypeIfSingletonObj()

getObjectTypeIfSingletonObj

public ObjectType getObjectTypeIfSingletonObj()

isInterfaceDefinition

public boolean isInterfaceDefinition()

withLoose
```
public JSType withLoose()
```
Turns the class-less object of this type (if any) into a loose object

getProp

public JSType getProp(QualifiedName qname)

getDeclaredProp

public JSType getDeclaredProp(QualifiedName qname)

mayHaveProp

public boolean mayHaveProp(QualifiedName qname)

hasProp

public boolean hasProp(QualifiedName qname)

hasConstantProp

public boolean hasConstantProp(QualifiedName pname)

withoutProperty

public JSType withoutProperty(QualifiedName qname)

withProperty

public JSType withProperty(QualifiedName qname,
                           JSType type)

withDeclaredProperty

public JSType withDeclaredProperty(QualifiedName qname,
                                   JSType type,
                                   boolean isConstant)

withPropertyRequired

public JSType withPropertyRequired(String pname)

toString
```
public String toString()
```
Overrides:

toString in class Object

appendTo

public StringBuilder appendTo(StringBuilder builder)

isConstructor
```
public boolean isConstructor()
```
Specified by:

isConstructor in interface TypeI

isEquivalentTo
```
public boolean isEquivalentTo(TypeI type)
```
Specified by:

isEquivalentTo in interface TypeI

isFunctionType
```
public boolean isFunctionType()
```
Specified by:

isFunctionType in interface TypeI

isInterface
```
public boolean isInterface()
```
Specified by:

isInterface in interface TypeI

isUnknownType
```
public boolean isUnknownType()
```
Specified by:

isUnknownType in interface TypeI

restrictByNotNullOrUndefined
```
public TypeI restrictByNotNullOrUndefined()
```
Specified by:

restrictByNotNullOrUndefined in interface TypeI

toMaybeFunctionType
```
public FunctionTypeI toMaybeFunctionType()
```
Specified by:

toMaybeFunctionType in interface TypeI

toMaybeObjectType
```
public ObjectTypeI toMaybeObjectType()
```
Specified by:

toMaybeObjectType in interface TypeI

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

Class JSType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BOTTOM_MASK

TYPEVAR_MASK

NON_SCALAR_MASK

ENUM_MASK

TRUE_MASK

FALSE_MASK

NULL_MASK

NUMBER_MASK

STRING_MASK

UNDEFINED_MASK

END_MASK

TRUTHY_MASK

FALSY_MASK

UNKNOWN_MASK

TOP_MASK

BOOLEAN_MASK

TOP_SCALAR_MASK

mockToString

BOOLEAN

BOTTOM

FALSE_TYPE

FALSY

NULL

NUMBER

STRING

TOP

TOP_SCALAR

TRUE_TYPE

TRUTHY

UNDEFINED

UNKNOWN

TOP_OBJECT

TOP_STRUCT

TOP_DICT

NULL_OR_UNDEF

NUM_OR_STR

Constructor Detail

JSType

Method Detail

getMask

getTypeVar

getEnums

getAlternates

fromObjectType

fromTypeVar

isTop

isBottom

isUnknown

isTruthy

isFalsy

isBoolean

isString

isNumber

isNullOrUndef

isScalar

hasNonScalar

isNullable

isTypeVariable

isStruct

isLooseStruct

isLoose

isDict

isEnumElement

isUnion

areCompatibleScalarTypes

getEnumeratedType

autobox

join

substituteGenerics

substituteGenericsWithUnknown

unifyWithSubtype

specialize

meet

plus