JSType (Closure Compiler Unshaded v20160713 API)

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

All Implemented Interfaces:

FunctionTypeI, ObjectTypeI, TypeI
```
public abstract class JSType
extends Object
implements FunctionTypeI, ObjectTypeI
```
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)`
`JSType`	`autobox()`
`JSType`	`autoboxAndGetObject()`
`boolean`	`containsArray()`
`TypeI`	`convertMethodToFunction()` Creates a new function type B based on the original function type A.
`boolean`	`equals(Object o)`
`JSType`	`findSubtypeWithProp(QualifiedName pname)`
`static JSType`	`fromObjectType(com.google.javascript.jscomp.newtypes.ObjectType obj)`
`static JSType`	`fromTypeVar(String typevarName)`
`FunctionTypeI`	`getConstructor()` Gets this object's constructor, or null if it is a native object (constructed natively vs.
`JSType`	`getDeclaredProp(QualifiedName qname)`
`String`	`getDisplayName()`
`JSType`	`getEnumeratedType()`
`protected abstract com.google.common.collect.ImmutableSet<EnumType>`	`getEnums()`
`FunctionType`	`getFunType()`
`FunctionType`	`getFunTypeIfSingletonObj()`
`JSType`	`getIndexedType()`
`JSType`	`getIndexType()`
`ObjectTypeI`	`getInstanceType()`
`JSDocInfo`	`getJSDocInfo()`
`JSType`	`getLowestSupertypeWithProperty(String propertyName, boolean isOverride)`
`protected abstract int`	`getMask()`
`NominalType`	`getNominalTypeIfSingletonObj()`
`Node`	`getOwnPropertyDefsite(String propertyName)`
`JSDocInfo`	`getOwnPropertyJSDocInfo(String propertyName)`
`JSType`	`getProp(QualifiedName qname)`
`Node`	`getPropertyDefsite(String propertyName)`
`JSType`	`getPrototypeObject()`
`String`	`getReferenceName()`
`TypeI`	`getReturnType()`
`Node`	`getSource()` Gets the AST Node where this function was defined.
`List<? extends FunctionTypeI>`	`getSubTypes()` Returns a list of types that are subtypes of this type.
`TypeI`	`getTypeOfThis()` Gets the type of `this` in this function.
`protected abstract String`	`getTypeVar()`
`boolean`	`hasConstantProp(QualifiedName pname)`
`int`	`hashCode()`
`boolean`	`hasNonScalar()`
`boolean`	`hasProp(QualifiedName qname)`
`boolean`	`hasProperties()`
`boolean`	`hasProperty(String propertyName)`
`boolean`	`hasTypeVariable()`
`static boolean`	`haveCommonSubtype(JSType lhs, JSType rhs)`
`boolean`	`isAnyFalsyType()`
`boolean`	`isAnyTruthyType()`
`boolean`	`isBoolean()`
`boolean`	`isBottom()`
`boolean`	`isConstructor()`
`boolean`	`isDict()`
`boolean`	`isEnumElement()`
`boolean`	`isEquivalentTo(TypeI type)`
`boolean`	`isFalseOrFalsy()`
`boolean`	`isFunctionType()`
`boolean`	`isFunctionWithProperties()`
`boolean`	`isInstanceofObject()`
`boolean`	`isInstanceType()` Whether this type is an instance object of some constructor.
`boolean`	`isInterface()`
`boolean`	`isInterfaceDefinition()`
`boolean`	`isInterfaceInstance()`
`boolean`	`isLoose()`
`boolean`	`isNamespace()`
`boolean`	`isNonClassyObject()`
`boolean`	`isNonLooseSubtypeOf(JSType other)`
`boolean`	`isNullable()`
`boolean`	`isNullOrUndef()`
`boolean`	`isNumber()`
`boolean`	`isOriginalConstructor()`
`boolean`	`isPrototypeObject()`
`boolean`	`isScalar()`
`boolean`	`isSingletonObj()`
`boolean`	`isString()`
`boolean`	`isStruct()`
`boolean`	`isSubtypeOf(TypeI other)`
`boolean`	`isTop()`
`boolean`	`isTrueOrTruthy()`
`boolean`	`isTypeVariable()`
`boolean`	`isUndefined()`
`boolean`	`isUnion()`
`boolean`	`isUnknown()`
`boolean`	`isUnknownType()`
`static JSType`	`join(JSType lhs, JSType rhs)`
`boolean`	`mayBeDict()`
`boolean`	`mayBeStruct()`
`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()` If this is a union type, returns a union type that does not include the null or undefined type.
`static void`	`setCommonTypes(JSTypes commonTypes)`
`void`	`setSource(Node n)`
`JSType`	`specialize(JSType other)`
`JSType`	`substituteGenerics(Map<String,JSType> concreteTypes)`
`JSType`	`substituteGenericsWithUnknown()`
`JSType`	`toBoolean()`
`FunctionTypeI`	`toMaybeFunctionType()` Downcasts this to a FunctionTypeI, or returns null if this is not a function.
`ObjectTypeI`	`toMaybeObjectType()` If this type is a single object, downcast it to ObjectTypeI.
`String`	`toString()`
`boolean`	`unifyWith(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.
`static MismatchInfo`	`whyNotSubtypeOf(JSType t1, JSType t2)`
`JSType`	`withDeclaredProperty(QualifiedName qname, JSType type, boolean isConstant)`
`JSType`	`withFunction(FunctionType ft, NominalType fnNominal)`
`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()

fromObjectType

public static JSType fromObjectType(com.google.javascript.jscomp.newtypes.ObjectType obj)

fromTypeVar

public static JSType fromTypeVar(String typevarName)

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

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

isBottom in interface TypeI

isUndefined
```
public boolean isUndefined()
```

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

isTrueOrTruthy
```
public boolean isTrueOrTruthy()
```

isFalseOrFalsy
```
public boolean isFalseOrFalsy()
```

isAnyTruthyType
```
public boolean isAnyTruthyType()
```

isAnyFalsyType
```
public boolean isAnyFalsyType()
```

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

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

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

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

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

setCommonTypes

public static void setCommonTypes(JSTypes commonTypes)

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

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

isNullable in interface TypeI

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

hasTypeVariable
```
public boolean hasTypeVariable()
```

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

mayBeStruct
```
public boolean mayBeStruct()
```

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

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

getIndexType
```
public JSType getIndexType()
```

getIndexedType
```
public JSType getIndexedType()
```

mayBeDict
```
public boolean mayBeDict()
```

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

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

isFunctionWithProperties

public boolean isFunctionWithProperties()

isNamespace
```
public boolean isNamespace()
```

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

autobox
```
public JSType autobox()
```

join

public static JSType join(JSType lhs,
                          JSType rhs)

substituteGenerics

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

substituteGenericsWithUnknown

public JSType substituteGenericsWithUnknown()

unifyWith
```
public boolean unifyWith(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 This method should only be called outside the newtypes package; classes inside the package should use unifyWithSubtype.

specialize

public JSType specialize(JSType other)

meet

public static JSType meet(JSType lhs,
                          JSType rhs)

haveCommonSubtype

public static boolean haveCommonSubtype(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

whyNotSubtypeOf

public static MismatchInfo whyNotSubtypeOf(JSType t1,
                                           JSType t2)

removeType

public JSType removeType(JSType other)

withFunction

public JSType withFunction(FunctionType ft,
                           NominalType fnNominal)

isSingletonObj
```
public boolean isSingletonObj()
```

getFunTypeIfSingletonObj

public FunctionType getFunTypeIfSingletonObj()

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

getNominalTypeIfSingletonObj

public NominalType getNominalTypeIfSingletonObj()

isInterfaceInstance
```
public boolean isInterfaceInstance()
```

isNonClassyObject
```
public boolean isNonClassyObject()
```

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)

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

containsArray in interface TypeI

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)

findSubtypeWithProp

public JSType findSubtypeWithProp(QualifiedName 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

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

isOriginalConstructor 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()
```
Description copied from interface: TypeI

If this is a union type, returns a union type that does not include the null or undefined type.

Specified by:

restrictByNotNullOrUndefined in interface TypeI

toMaybeFunctionType
```
public FunctionTypeI toMaybeFunctionType()
```
Description copied from interface: TypeI

Downcasts this to a FunctionTypeI, or returns null if this is not a function.

Specified by:

toMaybeFunctionType in interface TypeI

toMaybeObjectType
```
public ObjectTypeI toMaybeObjectType()
```
Description copied from interface: TypeI

If this type is a single object, downcast it to ObjectTypeI. If it is a non-object or a union of objects, return null.

Specified by:

toMaybeObjectType in interface TypeI

autoboxAndGetObject
```
public JSType autoboxAndGetObject()
```
Specified by:

autoboxAndGetObject in interface TypeI

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

equals in class Object

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

hashCode in class Object

getDisplayName
```
public String getDisplayName()
```
Specified by:

getDisplayName in interface TypeI

convertMethodToFunction
```
public TypeI convertMethodToFunction()
```
Description copied from interface: FunctionTypeI

Creates a new function type B based on the original function type A. Takes the receiver type (this type) of A and makes it the first argument of B; B has no receiver type. Used by the DevirtualizePrototypeMethods pass.

Specified by:

convertMethodToFunction in interface FunctionTypeI

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

getInstanceType in interface FunctionTypeI

getReferenceName
```
public String getReferenceName()
```
Specified by:

getReferenceName in interface FunctionTypeI

getSource
```
public Node getSource()
```
Description copied from interface: FunctionTypeI

Gets the AST Node where this function was defined.

Specified by:

getSource in interface FunctionTypeI

getSubTypes
```
public List<? extends FunctionTypeI> getSubTypes()
```
Description copied from interface: FunctionTypeI

Returns a list of types that are subtypes of this type. This is only valid for constructor functions, and may be null. This allows a downward traversal of the subtype graph.

Specified by:

getSubTypes in interface FunctionTypeI

getTypeOfThis
```
public TypeI getTypeOfThis()
```
Description copied from interface: FunctionTypeI

Gets the type of this in this function.

Specified by:

getTypeOfThis in interface FunctionTypeI

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

hasProperties in interface FunctionTypeI

setSource
```
public void setSource(Node n)
```
Specified by:

setSource in interface FunctionTypeI

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

getReturnType in interface FunctionTypeI

getConstructor
```
public FunctionTypeI getConstructor()
```
Description copied from interface: ObjectTypeI

Gets this object's constructor, or null if it is a native object (constructed natively vs. by instantiation of a function).

Specified by:

getConstructor in interface ObjectTypeI

getPrototypeObject
```
public JSType getPrototypeObject()
```
Specified by:

getPrototypeObject in interface ObjectTypeI

getJSDocInfo
```
public JSDocInfo getJSDocInfo()
```
Specified by:

getJSDocInfo in interface TypeI

getOwnPropertyJSDocInfo
```
public JSDocInfo getOwnPropertyJSDocInfo(String propertyName)
```
Specified by:

getOwnPropertyJSDocInfo in interface ObjectTypeI

getOwnPropertyDefsite
```
public Node getOwnPropertyDefsite(String propertyName)
```
Specified by:

getOwnPropertyDefsite in interface ObjectTypeI

getPropertyDefsite
```
public Node getPropertyDefsite(String propertyName)
```
Specified by:

getPropertyDefsite in interface ObjectTypeI

getLowestSupertypeWithProperty

public JSType getLowestSupertypeWithProperty(String propertyName,
                                             boolean isOverride)

Specified by:: getLowestSupertypeWithProperty in interface ObjectTypeI

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

isPrototypeObject in interface TypeI

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

isInstanceofObject in interface TypeI

isInstanceType
```
public boolean isInstanceType()
```
Description copied from interface: ObjectTypeI

Whether this type is an instance object of some constructor.

Specified by:

isInstanceType in interface ObjectTypeI

hasProperty
```
public boolean hasProperty(String propertyName)
```
Specified by:

hasProperty in interface ObjectTypeI

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

fromObjectType

fromTypeVar

isTop

isBottom

isUndefined

isUnknown

isTrueOrTruthy

isFalseOrFalsy

isAnyTruthyType

isAnyFalsyType

isBoolean

isString

isNumber

isNullOrUndef

isScalar

setCommonTypes

hasNonScalar

isNullable

isTypeVariable

hasTypeVariable

isStruct

mayBeStruct

isLoose

isDict

getIndexType

getIndexedType

mayBeDict

isEnumElement

isUnion

isFunctionWithProperties

isNamespace

getEnumeratedType