JSType (Closure Compiler v20140407 API)

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

```
public class JSType
extends Object
```
Author:

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

Field Summary

Fields
Modifier and Type	Field and Description
`static JSType`	`BOOLEAN`
`static JSType`	`BOTTOM`
`static JSType`	`FALSE_TYPE`
`static JSType`	`FALSY`
`static JSType`	`NULL`
`static JSType`	`NULL_OR_UNDEF`
`static JSType`	`NUM_OR_STR`
`static JSType`	`NUMBER`
`static JSType`	`STRING`
`static JSType`	`TOP`
`static JSType`	`TOP_DICT`
`static JSType`	`TOP_OBJECT`
`static JSType`	`TOP_SCALAR`
`static JSType`	`TOP_STRUCT`
`static JSType`	`TRUE_TYPE`
`static JSType`	`TRUTHY`
`static JSType`	`UNDEFINED`
`static JSType`	`UNKNOWN`

Method Summary

Methods
Modifier and Type	Method and Description
`static boolean`	`areCompatibleScalarTypes(JSType lhs, JSType rhs)`
`boolean`	`equals(Object o)`
`static JSType`	`fromFunctionType(FunctionType fn)`
`static JSType`	`fromObjectType(ObjectType obj)`
`static JSType`	`fromTypeVar(String template)`
`JSType`	`getDeclaredProp(QualifiedName qname)`
`FunctionType`	`getFunType()`
`FunctionType`	`getFunTypeIfSingletonObj()`
`String`	`getLocation()`
`JSType`	`getProp(QualifiedName qname)`
`int`	`hashCode()`
`boolean`	`hasInferredProp(QualifiedName pname)`
`boolean`	`hasNonScalar()`
`boolean`	`hasProp(QualifiedName qname)`
`boolean`	`isBoolean()`
`boolean`	`isBottom()`
`boolean`	`isDict()`
`boolean`	`isFalsy()`
`boolean`	`isInhabitable()`
`boolean`	`isInterfaceDefinition()`
`boolean`	`isNullable()`
`boolean`	`isNullOrUndef()`
`boolean`	`isScalar()`
`boolean`	`isStruct()`
`boolean`	`isSubtypeOf(JSType other)`
`boolean`	`isTop()`
`boolean`	`isTruthy()`
`boolean`	`isUnknown()`
`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)`
`JSType`	`specialize(JSType other)`
`JSType`	`substituteGenerics(Map<String,JSType> concreteTypes)`
`JSType`	`toBoolean()`
`static JSType`	`topFunction()`
`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 type, modifying the supplied `typeMultimap` to add any new template variable type bindings.
`JSType`	`withDeclaredProperty(QualifiedName qname, JSType type)`
`JSType`	`withLocation(String location)`
`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

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
```

Method Detail

fromFunctionType

public static JSType fromFunctionType(FunctionType fn)

fromObjectType

public static JSType fromObjectType(ObjectType obj)

fromTypeVar

public static JSType fromTypeVar(String template)

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

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

isBottom
```
public boolean isBottom()
```

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

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

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

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

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

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

isInhabitable
```
public boolean isInhabitable()
```

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

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

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

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

areCompatibleScalarTypes

public static boolean areCompatibleScalarTypes(JSType lhs,
                               JSType rhs)

join

public static JSType join(JSType lhs,
          JSType rhs)

substituteGenerics

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

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 type, modifying the supplied typeMultimap to add any new template variable type bindings.

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()
```

isSubtypeOf

public boolean isSubtypeOf(JSType other)

removeType

public JSType removeType(JSType other)

withLocation

public JSType withLocation(String location)

getLocation
```
public String getLocation()
```

getFunTypeIfSingletonObj

public FunctionType getFunTypeIfSingletonObj()

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

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)

mayHaveProp

public boolean mayHaveProp(QualifiedName qname)

hasProp

public boolean hasProp(QualifiedName qname)

hasInferredProp

public boolean hasInferredProp(QualifiedName pname)

getDeclaredProp

public JSType getDeclaredProp(QualifiedName qname)

withoutProperty

public JSType withoutProperty(QualifiedName qname)

withProperty

public JSType withProperty(QualifiedName qname,
                  JSType type)

withDeclaredProperty

public JSType withDeclaredProperty(QualifiedName qname,
                          JSType type)

withPropertyRequired

public JSType withPropertyRequired(String pname)

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

toString in class Object

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

equals in class Object

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

hashCode in class Object

Class JSType

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

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

Method Detail

fromFunctionType

fromObjectType

fromTypeVar

topFunction

isTop

isBottom

isUnknown

isTruthy

isFalsy

isBoolean

isNullOrUndef

isScalar

isInhabitable

hasNonScalar

isNullable

isStruct

isDict

areCompatibleScalarTypes

join

substituteGenerics

unifyWith

specialize

meet

plus

negate

toBoolean

isSubtypeOf

removeType

withLocation

getLocation

getFunTypeIfSingletonObj

getFunType

isInterfaceDefinition

withLoose

getProp

mayHaveProp

hasProp

hasInferredProp

getDeclaredProp

withoutProperty

withProperty

withDeclaredProperty

withPropertyRequired

toString

equals

hashCode