JSTypes (Closure Compiler v20170910 API)

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

All Implemented Interfaces:

Serializable
```
public final class JSTypes
extends Object
implements Serializable
```
This class contains state that stays the same throughout a single type check, but can vary across different compilations. 1) It contains the built-in types, which we initialize when we read their definitions in externs. 2) It knows whether we are in compatibility mode (looser checks in the style of the old type checker). Built-in nominal types (Function, Object, Array, String, etc.) must be set explicitly in externs, and are set with the corresponding setter methods as they are crawled. They will remain null if not defined anywhere. There should only be one instance of this class per Compiler object.

Author:

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

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`JSType`	`BOOLEAN`
`JSType`	`BOTTOM`
`JSType`	`FALSE_TYPE`
`JSType`	`FALSY`
`JSType`	`NULL`
`JSType`	`NULL_OR_UNDEFINED`
`JSType`	`NUMBER`
`JSType`	`NUMBER_OR_STRING`
`static String`	`OBJLIT_CLASS_NAME`
`JSType`	`STRING`
`JSType`	`TOP`
`JSType`	`TOP_SCALAR`
`JSType`	`TRUE_TYPE`
`JSType`	`TRUTHY`
`JSType`	`UNDEFINED`
`JSType`	`UNKNOWN`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`createGetterPropName(String originalPropName)`
`String`	`createSetterPropName(String originalPropName)`
`JSType`	`fromFunctionType(FunctionType fn)`
`JSType`	`getArgumentsArrayType()`
`JSType`	`getArgumentsArrayType(JSType t)`
`JSType`	`getArrayInstance()`
`JSType`	`getArrayInstance(JSType t)`
`JSType`	`getBooleanInstance()`
`JSType`	`getEmptyObjectLiteral()`
`NominalType`	`getFunctionType()`
`JSType`	`getGeneratorInstance(JSType t)`
`JSType`	`getGlobalThis()`
`JSType`	`getIArrayLikeInstance(JSType t)`
`JSType`	`getIIterableResultInstance(JSType t)`
`RawNominalType`	`getIObjectType()`
`JSType`	`getITemplateArrayType()`
`JSType`	`getIterableInstance(JSType t)`
`JSType`	`getIteratorInstance(JSType t)`
`NominalType`	`getLiteralObjNominalType()`
`JSType`	`getNativeType(JSTypeNative typeId)`
`JSType`	`getNumberInstance()`
`NominalType`	`getObjectType()`
`JSType`	`getRegexpType()`
`JSType`	`getStringInstance()`
`JSType`	`getTopDict()`
`JSType`	`getTopObject()`
`JSType`	`getTopStruct()`
`static JSTypes`	`init(boolean inCompatibilityMode)`
`boolean`	`isNumberScalarOrObj(JSType t)`
`boolean`	`isNumStrScalarOrObj(JSType t)`
`boolean`	`isStringScalarOrObj(JSType t)`
`JSType`	`looseTopFunction()`
`JSType`	`qmarkFunction()`
`void`	`setArgumentsType(RawNominalType arguments)`
`void`	`setArrayType(RawNominalType arrayType)`
`void`	`setBooleanInstance(JSType t)`
`void`	`setFunctionType(RawNominalType builtinFunction)`
`void`	`setGeneratorType(RawNominalType generator)`
`void`	`setGlobalThis(JSType globalThis)`
`void`	`setIArrayLikeType(RawNominalType iArrayLike)`
`void`	`setIIterableResultType(RawNominalType iIterableResult)`
`void`	`setIObjectType(RawNominalType iObject)`
`void`	`setITemplateArrayType(RawNominalType iTemplateArray)`
`void`	`setIterableType(RawNominalType iterable)`
`void`	`setIteratorType(RawNominalType iterator)`
`void`	`setLiteralObjNominalType(RawNominalType literalObject)`
`void`	`setNumberInstance(JSType t)`
`void`	`setObjectType(RawNominalType builtinObject)`
`void`	`setRegexpInstance(JSType regexpInstance)`
`void`	`setStringInstance(JSType t)`
`JSType`	`topFunction()`

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

Field Detail

OBJLIT_CLASS_NAME

public static final String OBJLIT_CLASS_NAME

See Also:: Constant Field Values

BOOLEAN
```
public final JSType BOOLEAN
```

BOTTOM
```
public final JSType BOTTOM
```

FALSE_TYPE
```
public final JSType FALSE_TYPE
```

FALSY
```
public final JSType FALSY
```

NULL
```
public final JSType NULL
```

NUMBER
```
public final JSType NUMBER
```

STRING
```
public final JSType STRING
```

TOP
```
public final JSType TOP
```

TOP_SCALAR
```
public final JSType TOP_SCALAR
```

TRUE_TYPE
```
public final JSType TRUE_TYPE
```

TRUTHY
```
public final JSType TRUTHY
```

UNDEFINED
```
public final JSType UNDEFINED
```

UNKNOWN
```
public final JSType UNKNOWN
```

NUMBER_OR_STRING
```
public final JSType NUMBER_OR_STRING
```

NULL_OR_UNDEFINED
```
public final JSType NULL_OR_UNDEFINED
```

Method Detail

init

public static JSTypes init(boolean inCompatibilityMode)

fromFunctionType

public JSType fromFunctionType(FunctionType fn)

getFunctionType
```
public NominalType getFunctionType()
```

looseTopFunction
```
public JSType looseTopFunction()
```

topFunction
```
public JSType topFunction()
```

qmarkFunction
```
public JSType qmarkFunction()
```

getArrayInstance
```
public JSType getArrayInstance()
```

getIArrayLikeInstance

public JSType getIArrayLikeInstance(JSType t)

getIterableInstance

public JSType getIterableInstance(JSType t)

getIteratorInstance

public JSType getIteratorInstance(JSType t)

getIIterableResultInstance

public JSType getIIterableResultInstance(JSType t)

getGeneratorInstance

public JSType getGeneratorInstance(JSType t)

getObjectType
```
public NominalType getObjectType()
```

getLiteralObjNominalType

public NominalType getLiteralObjNominalType()

getEmptyObjectLiteral
```
public JSType getEmptyObjectLiteral()
```

getTopObject
```
public JSType getTopObject()
```

getTopStruct
```
public JSType getTopStruct()
```

getTopDict
```
public JSType getTopDict()
```

getIObjectType

public RawNominalType getIObjectType()

getArrayInstance

public JSType getArrayInstance(JSType t)

getArgumentsArrayType

public JSType getArgumentsArrayType(JSType t)

getRegexpType
```
public JSType getRegexpType()
```

getGlobalThis
```
public JSType getGlobalThis()
```

getNumberInstance
```
public JSType getNumberInstance()
```

getBooleanInstance
```
public JSType getBooleanInstance()
```

getStringInstance
```
public JSType getStringInstance()
```

getArgumentsArrayType
```
public JSType getArgumentsArrayType()
```

getITemplateArrayType
```
public JSType getITemplateArrayType()
```

getNativeType

public JSType getNativeType(JSTypeNative typeId)

setArgumentsType

public void setArgumentsType(RawNominalType arguments)

setFunctionType

public void setFunctionType(RawNominalType builtinFunction)

setObjectType

public void setObjectType(RawNominalType builtinObject)

setLiteralObjNominalType

public void setLiteralObjNominalType(RawNominalType literalObject)

setArrayType

public void setArrayType(RawNominalType arrayType)

setIObjectType

public void setIObjectType(RawNominalType iObject)

setIArrayLikeType

public void setIArrayLikeType(RawNominalType iArrayLike)

setIterableType

public void setIterableType(RawNominalType iterable)

setIteratorType

public void setIteratorType(RawNominalType iterator)

setIIterableResultType

public void setIIterableResultType(RawNominalType iIterableResult)

setITemplateArrayType

public void setITemplateArrayType(RawNominalType iTemplateArray)

setGeneratorType

public void setGeneratorType(RawNominalType generator)

setRegexpInstance

public void setRegexpInstance(JSType regexpInstance)

setGlobalThis

public void setGlobalThis(JSType globalThis)

setNumberInstance

public void setNumberInstance(JSType t)

setBooleanInstance

public void setBooleanInstance(JSType t)

setStringInstance

public void setStringInstance(JSType t)

isNumberScalarOrObj

public boolean isNumberScalarOrObj(JSType t)

isStringScalarOrObj

public boolean isStringScalarOrObj(JSType t)

isNumStrScalarOrObj

public boolean isNumStrScalarOrObj(JSType t)

createGetterPropName

public String createGetterPropName(String originalPropName)

createSetterPropName

public String createSetterPropName(String originalPropName)

Class JSTypes

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OBJLIT_CLASS_NAME

BOOLEAN

BOTTOM

FALSE_TYPE

FALSY

NULL

NUMBER

STRING

TOP

TOP_SCALAR

TRUE_TYPE

TRUTHY

UNDEFINED

UNKNOWN

NUMBER_OR_STRING

NULL_OR_UNDEFINED

Method Detail

init

fromFunctionType

getFunctionType

looseTopFunction

topFunction

qmarkFunction

getArrayInstance

getIArrayLikeInstance

getIterableInstance

getIteratorInstance

getIIterableResultInstance

getGeneratorInstance

getObjectType

getLiteralObjNominalType

getEmptyObjectLiteral

getTopObject

getTopStruct

getTopDict

getIObjectType

getArrayInstance

getArgumentsArrayType

getRegexpType

getGlobalThis

getNumberInstance

getBooleanInstance

getStringInstance

getArgumentsArrayType

getITemplateArrayType

getNativeType

setArgumentsType

setFunctionType

setObjectType

setLiteralObjNominalType

setArrayType

setIObjectType

setIArrayLikeType

setIterableType

setIteratorType

setIIterableResultType

setITemplateArrayType

setGeneratorType

setRegexpInstance

setGlobalThis

setNumberInstance

setBooleanInstance

setStringInstance

isNumberScalarOrObj

isStringScalarOrObj

isNumStrScalarOrObj

createGetterPropName

createSetterPropName