JSType (Closure Compiler Unshaded v20170626 API)

java.lang.Object
- com.google.javascript.rhino.jstype.JSType

All Implemented Interfaces:

TypeI, Serializable

Direct Known Subclasses:

AllType, BooleanType, NullType, NumberType, ObjectType, StringType, UnionType, VoidType
```
public abstract class JSType
extends Object
implements TypeI
```
Represents JavaScript value types.
Types are split into two separate families: value types and object types. A special UnknownType exists to represent a wildcard type on which no information can be gathered. In particular, it can assign to everyone, is a subtype of everyone (and everyone is a subtype of it).
If you remove the UnknownType, the set of types in the type system forms a lattice with the isSubtype(com.google.javascript.rhino.jstype.JSType) relation defining the partial order of types. All types are united at the top of the lattice by the AllType and at the bottom by the NoType.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`JSType.SubtypingMode` In files translated from Java, we typecheck null and undefined loosely.
`static class`	`JSType.TypePair` a data structure that represents a pair of types

Field Summary

Fields
Modifier and Type Field and Description

protected TemplateTypeMap templateTypeMap

Fields
Modifier and Type	Field and Description
`protected TemplateTypeMap`	`templateTypeMap`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`JSType`	`autobox()` Dereference a type for property access.
`ObjectType`	`autoboxAndGetObject()`
`JSType`	`autoboxesTo()` Turn a scalar type to the corresponding object type.
`boolean`	`canBeCalled()` This predicate is used to test whether a given type can be used as the 'function' in a function call.
`boolean`	`canCastTo(JSType that)` Tests whether values of `this` type can be safely assigned to values of `that` type.
`boolean`	`canTestForEqualityWith(JSType that)` Tests whether `this` and `that` are meaningfully comparable.
`boolean`	`canTestForShallowEqualityWith(JSType that)` Tests whether `this` and `that` are meaningfully comparable using shallow comparison.
`JSType`	`collapseUnion()` Gets the least supertype of this that's not a union.
`boolean`	`containsArray()`
`ObjectType`	`dereference()` Dereference a type for property access.
`boolean`	`differsFrom(JSType that)` Whether this type is meaningfully different from `that` type for the purposes of data flow analysis.
`boolean`	`equals(Object jsType)`
`void`	`extendTemplateTypeMap(TemplateTypeMap otherMap)` Extends the template type map associated with this type, merging in the keys and values of the specified map.
`JSType`	`findPropertyType(String propertyName)` Coerces this type to an Object type, then gets the type of the property whose name is given.
`String`	`getDisplayName()` Returns a user meaningful label for the JSType instance.
`JSType`	`getEnumeratedTypeOfEnumElement()`
`JSType`	`getGreatestSubtype(JSType that)` Gets the greatest subtype of `this` and `that`.
`JSType`	`getGreatestSubtypeWithProperty(String propName)`
`JSDocInfo`	`getJSDocInfo()` Gets the docInfo for this type.
`JSType`	`getLeastSupertype(JSType that)` Gets the least supertype of `this` and `that`.
`abstract BooleanLiteralSet`	`getPossibleToBooleanOutcomes()` Computes the set of possible outcomes of the `ToBoolean` predicate for this type.
`JSType`	`getRestrictedTypeGivenToBooleanOutcome(boolean outcome)` Computes the restricted type of this type knowing that the `ToBoolean` predicate has a specific value.
`TemplateTypeMap`	`getTemplateTypeMap()` Returns the template type map associated with this type.
`JSType.TypePair`	`getTypesUnderEquality(JSType that)` Computes the subset of `this` and `that` types if equality is observed.
`JSType.TypePair`	`getTypesUnderInequality(JSType that)` Computes the subset of `this` and `that` types if inequality is observed.
`JSType.TypePair`	`getTypesUnderShallowEquality(JSType that)` Computes the subset of `this` and `that` types under shallow equality.
`JSType.TypePair`	`getTypesUnderShallowInequality(JSType that)` Computes the subset of `this` and `that` types under shallow inequality.
`Iterable<JSType>`	`getUnionMembers()` If this type is a union type, returns a list of its members.
`boolean`	`hasAnyTemplateTypes()`
`boolean`	`hasDisplayName()`
`abstract int`	`hashCode()`
`boolean`	`hasProperty(String pname)` Checks whether the property is present on the object.
`boolean`	`hasUninstantiatedTypeVariables()` Returns true if this type is a generic object (non function) and some (or all) of its type variables are not instantiated.
`boolean`	`isAllType()`
`boolean`	`isArrayType()`
`boolean`	`isBooleanObjectType()`
`boolean`	`isBooleanValueType()` Whether the type is a scalar boolean.
`boolean`	`isBottom()`
`boolean`	`isBoxableScalar()`
`boolean`	`isCheckedUnknownType()`
`boolean`	`isConstructor()` Whether this type is a `FunctionType` that is a constructor or a named type that points to such a type.
`boolean`	`isDateType()`
`boolean`	`isDict()` Returns true iff `this` can be a `dict`.
`boolean`	`isEmptyType()`
`boolean`	`isEnumElement()`
`boolean`	`isEnumElementType()`
`boolean`	`isEnumObject()`
`boolean`	`isEnumType()`
`static boolean`	`isEquivalent(JSType typeA, JSType typeB)`
`boolean`	`isEquivalentTo(TypeI that)` Checks if two types are equivalent.
`boolean`	`isEquivalentTo(TypeI that, boolean isStructural)`
`boolean`	`isExplicitlyVoidable()` Tests whether this type explicitly allows undefined, as opposed to ? or *.
`boolean`	`isFunctionPrototypeType()` Whether this is the prototype of a function.
`boolean`	`isFunctionType()` Returns true if toMaybeFunctionType returns a non-null FunctionType.
`boolean`	`isGenericObjectType()` True if this type represents a generic object (non function) type, instantiated or not.
`boolean`	`isGlobalThisType()` Returns true if this is a global this type.
`boolean`	`isInstanceofObject()` True when the nominal type of this type is Object.
`boolean`	`isInstanceType()` Whether this type is an Instance object of some constructor.
`boolean`	`isInterface()` Whether this type is a `FunctionType` that is an interface or a named type that points to such a type.
`boolean`	`isLegacyNamedType()`
`boolean`	`isLiteralObject()`
`boolean`	`isNamedType()`
`boolean`	`isNominalConstructor()` Whether this type is the original constructor of a nominal type.
`boolean`	`isNominalType()` Whether this type is a nominal type (a named instance object or a named enum).
`boolean`	`isNoObjectType()`
`boolean`	`isNoResolvedType()`
`boolean`	`isNoType()`
`boolean`	`isNullable()` Tests whether this type is nullable.
`boolean`	`isNullType()`
`boolean`	`isNumber()` Tests whether the type is a number (value or Object).
`boolean`	`isNumberObjectType()`
`boolean`	`isNumberValueType()` Whether the type is a scalar number.
`boolean`	`isObject()` Tests whether this type is an `Object`, or any subtype thereof.
`boolean`	`isObjectType()`
`boolean`	`isOrdinaryFunction()` Whether this type is a `FunctionType` that is an ordinary function or a named type that points to such a type.
`boolean`	`isPrototypeObject()`
`boolean`	`isRecordType()` Whether this type represents an anonymous structural type, e.g., { a: number, b: string }.
`boolean`	`isRegexpType()`
`boolean`	`isResolved()` Whether the type has been resolved.
`boolean`	`isSomeUnknownType()`
`boolean`	`isString()` Tests whether the type is a string (value or Object).
`boolean`	`isStringObjectType()`
`boolean`	`isStringValueType()` Whether the type is a scalar string.
`boolean`	`isStruct()` Returns true iff `this` can be a `struct`.
`boolean`	`isStructuralInterface()`
`boolean`	`isStructuralType()`
`boolean`	`isSubtype(JSType that)` Checks whether `this` is a subtype of `that`.
`protected boolean`	`isSubtype(JSType that, com.google.javascript.rhino.jstype.JSType.ImplCache implicitImplCache, JSType.SubtypingMode subtypingMode)` checking isSubtype with structural interface matching
`boolean`	`isSubtype(JSType that, JSType.SubtypingMode mode)`
`boolean`	`isSubtypeOf(TypeI other)`
`boolean`	`isSubtypeWithoutStructuralTyping(TypeI that)` the logic of this method is similar to isSubtype, except that it does not perform structural interface matching This function is added for disambiguate properties, and is deprecated for the other use cases.
`boolean`	`isTemplateType()`
`boolean`	`isTemplatizedType()`
`boolean`	`isTop()`
`boolean`	`isTypeVariable()`
`boolean`	`isUnionType()`
`boolean`	`isUnknownType()`
`boolean`	`isUnresolved()`
`boolean`	`isUnresolvedOrResolvedUnknown()`
`boolean`	`isVoidable()` Tests whether this type is voidable.
`boolean`	`isVoidType()`
`void`	`matchConstraint(JSType constraint)` Modify this type so that it matches the specified type.
`boolean`	`matchesInt32Context()` This predicate is used to test whether a given type can appear in a 'Int32' context.
`boolean`	`matchesNumberContext()` This predicate is used to test whether a given type can appear in a numeric context, such as an operand of a multiply operator.
`boolean`	`matchesObjectContext()` This predicate is used to test whether a given type can appear in an `Object` context, such as the expression in a with statement.
`boolean`	`matchesStringContext()` This predicate is used to test whether a given type can appear in a `String` context, such as an operand of a string concat (+) operator.
`boolean`	`matchesUint32Context()` This predicate is used to test whether a given type can appear in a 'Uint32' context.
`TypeI`	`meetWith(TypeI that)`
`JSType`	`resolve(ErrorReporter t, StaticTypedScope<JSType> scope)` Resolve this type in the given scope.
`JSType`	`restrictByNotNullOrUndefined()` If this is a union type, returns a union type that does not include the null or undefined type.
`boolean`	`setValidator(com.google.common.base.Predicate<JSType> validator)` Certain types have constraints on them at resolution-time.
`TernaryValue`	`testForEquality(JSType that)` Compares `this` and `that`.
`String`	`toAnnotationString()` A string representation of this type, suitable for printing in type annotations at code generation time.
`String`	`toDebugHashCodeString()` A hash code function for diagnosing complicated issues around type-identity.
`EnumElementType`	`toMaybeEnumElementType()` Downcasts this to an EnumElementType, or returns null if this is not an EnumElementType.
`EnumType`	`toMaybeEnumType()` Downcasts this to an EnumType, or returns null if this is not an EnumType.
`FunctionType`	`toMaybeFunctionType()` Downcasts this to a FunctionType, or returns null if this is not a function.
`static FunctionType`	`toMaybeFunctionType(JSType type)` Null-safe version of toMaybeFunctionType().
`NamedType`	`toMaybeNamedType()`
`ObjectType`	`toMaybeObjectType()` If this type is a single object, downcast it to ObjectTypeI.
`RecordType`	`toMaybeRecordType()` Downcasts this to a RecordType, or returns null if this is not a RecordType.
`TemplateType`	`toMaybeTemplateType()` Downcasts this to a TemplateType, or returns null if this is not a function.
`TemplatizedType`	`toMaybeTemplatizedType()` Downcasts this to a TemplatizedType, or returns null if this is not a function.
`UnionType`	`toMaybeUnionType()` Downcasts this to a UnionType, or returns null if this is not a UnionType.
`String`	`toNonNullAnnotationString()` Returns a string representation of this type, suitable for printing in type annotations at code generation time.
`ObjectType`	`toObjectType()` Casts this to an ObjectType, or returns null if this is not an ObjectType.
`String`	`toString()` A string representation of this type, suitable for printing in warnings.
`JSType`	`unboxesTo()` Turn an object type to its corresponding scalar type.
`abstract <T> T`	`visit(Visitor<T> visitor)` Visit this type with the given visitor.

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

- Field Detail
  - templateTypeMap
```
protected TemplateTypeMap templateTypeMap
```
- Method Detail
  - getJSDocInfo
```
public JSDocInfo getJSDocInfo()
```
    Gets the docInfo for this type. By default, documentation cannot be attached to arbitrary types. This must be overridden for programmer-defined types.
    
    Specified by:
    
    getJSDocInfo in interface TypeI
  - getDisplayName
```
public String getDisplayName()
```
    Returns a user meaningful label for the JSType instance. For example, Functions and Enums will return their declaration name (if they have one). Some types will not have a meaningful display name. Calls to hasDisplayName() will return true IFF getDisplayName() will return null or a zero length string.
    
    Specified by:
    
    getDisplayName in interface TypeI
    
    Returns:
    
    the display name of the type, or null if one is not available
  - hasDisplayName
```
public boolean hasDisplayName()
```
    Returns:
    
    true if the JSType has a user meaningful label.
  - hasProperty
```
public boolean hasProperty(String pname)
```
    Checks whether the property is present on the object.
    
    Parameters:
    
    pname - The property name.
  - isNoType
```
public boolean isNoType()
```
  - isNoResolvedType
```
public boolean isNoResolvedType()
```
  - isUnresolved
```
public final boolean isUnresolved()
```
    Specified by:
    
    isUnresolved in interface TypeI
  - isUnresolvedOrResolvedUnknown
```
public final boolean isUnresolvedOrResolvedUnknown()
```
    Specified by:
    
    isUnresolvedOrResolvedUnknown in interface TypeI
  - isNoObjectType
```
public boolean isNoObjectType()
```
  - isEmptyType
```
public final boolean isEmptyType()
```
  - isNumberObjectType
```
public boolean isNumberObjectType()
```
  - isNumberValueType
```
public boolean isNumberValueType()
```
    Description copied from interface: TypeI
    
    Whether the type is a scalar number. In OTI, the isNumber method returns true for Number objects as well.
    
    Specified by:
    
    isNumberValueType in interface TypeI
  - isFunctionPrototypeType
```
public boolean isFunctionPrototypeType()
```
    Whether this is the prototype of a function.
  - isPrototypeObject
```
public boolean isPrototypeObject()
```
    Specified by:
    
    isPrototypeObject in interface TypeI
  - isStringObjectType
```
public boolean isStringObjectType()
```
  - isStringValueType
```
public boolean isStringValueType()
```
    Description copied from interface: TypeI
    
    Whether the type is a scalar string. In OTI, the isString method returns true for String objects as well.
    
    Specified by:
    
    isStringValueType in interface TypeI
  - isString
```
public final boolean isString()
```
    Tests whether the type is a string (value or Object).
    
    Returns:
    
    this <: (String, string)
  - isNumber
```
public final boolean isNumber()
```
    Tests whether the type is a number (value or Object).
    
    Returns:
    
    this <: (Number, number)
  - isArrayType
```
public boolean isArrayType()
```
  - isBooleanObjectType
```
public boolean isBooleanObjectType()
```
  - isBooleanValueType
```
public boolean isBooleanValueType()
```
    Description copied from interface: TypeI
    
    Whether the type is a scalar boolean. In OTI, the isBoolean method returns true for Boolean objects as well.
    
    Specified by:
    
    isBooleanValueType in interface TypeI
  - isRegexpType
```
public boolean isRegexpType()
```
  - isDateType
```
public boolean isDateType()
```
  - isNullType
```
public boolean isNullType()
```
    Specified by:
    
    isNullType in interface TypeI
  - isVoidType
```
public boolean isVoidType()
```
    Specified by:
    
    isVoidType in interface TypeI
  - isAllType
```
public boolean isAllType()
```
  - isTop
```
public final boolean isTop()
```
    Specified by:
    
    isTop in interface TypeI
  - isUnknownType
```
public boolean isUnknownType()
```
    Specified by:
    
    isUnknownType in interface TypeI
  - isSomeUnknownType
```
public final boolean isSomeUnknownType()
```
    Specified by:
    
    isSomeUnknownType in interface TypeI
  - isCheckedUnknownType
```
public boolean isCheckedUnknownType()
```
  - isUnionType
```
public final boolean isUnionType()
```
    Specified by:
    
    isUnionType in interface TypeI
  - hasUninstantiatedTypeVariables
```
public boolean hasUninstantiatedTypeVariables()
```
    Description copied from interface: TypeI
    
    Returns true if this type is a generic object (non function) and some (or all) of its type variables are not instantiated. Note that in OTI it is possible to instantiate only some of the type variables of a generic type (bad implementation choice). In NTI, a generic type can only be uninstantiated or fully instantiated.
    
    Specified by:
    
    hasUninstantiatedTypeVariables in interface TypeI
  - containsArray
```
public boolean containsArray()
```
    Specified by:
    
    containsArray in interface TypeI
  - isStruct
```
public boolean isStruct()
```
    Returns true iff this can be a struct. UnionType overrides the method, assume this is not a union here.
  - isDict
```
public boolean isDict()
```
    Returns true iff this can be a dict. UnionType overrides the method, assume this is not a union here.
  - isLiteralObject
```
public final boolean isLiteralObject()
```
    Specified by:
    
    isLiteralObject in interface TypeI
  - getGreatestSubtypeWithProperty
```
public JSType getGreatestSubtypeWithProperty(String propName)
```
    Specified by:
    
    getGreatestSubtypeWithProperty in interface TypeI
  - toMaybeUnionType
```
public UnionType toMaybeUnionType()
```
    Downcasts this to a UnionType, or returns null if this is not a UnionType. Named in honor of Haskell's Maybe type constructor.
  - isGlobalThisType
```
public final boolean isGlobalThisType()
```
    Returns true if this is a global this type.
  - isFunctionType
```
public final boolean isFunctionType()
```
    Returns true if toMaybeFunctionType returns a non-null FunctionType.
    
    Specified by:
    
    isFunctionType in interface TypeI
  - toMaybeFunctionType
```
public FunctionType toMaybeFunctionType()
```
    Downcasts this to a FunctionType, or returns null if this is not a function. For the purposes of this function, we define a MaybeFunctionType as any type in the sub-lattice { x | LEAST_FUNCTION_TYPE <= x <= GREATEST_FUNCTION_TYPE } This definition excludes bottom types like NoType and NoObjectType. This definition is somewhat arbitrary and axiomatic, but this is the definition that makes the most sense for the most callers.
    
    Specified by:
    
    toMaybeFunctionType in interface TypeI
  - toMaybeFunctionType
```
public static FunctionType toMaybeFunctionType(JSType type)
```
    Null-safe version of toMaybeFunctionType().
  - isEnumElementType
```
public final boolean isEnumElementType()
```
  - isEnumElement
```
public final boolean isEnumElement()
```
    Specified by:
    
    isEnumElement in interface TypeI
  - getEnumeratedTypeOfEnumElement
```
public final JSType getEnumeratedTypeOfEnumElement()
```
    Specified by:
    
    getEnumeratedTypeOfEnumElement in interface TypeI
  - toMaybeEnumElementType
```
public EnumElementType toMaybeEnumElementType()
```
    Downcasts this to an EnumElementType, or returns null if this is not an EnumElementType.
  - isEnumType
```
public boolean isEnumType()
```
  - isEnumObject
```
public final boolean isEnumObject()
```
    Specified by:
    
    isEnumObject in interface TypeI
  - toMaybeEnumType
```
public EnumType toMaybeEnumType()
```
    Downcasts this to an EnumType, or returns null if this is not an EnumType.
  - isNamedType
```
public boolean isNamedType()
```
  - isLegacyNamedType
```
public boolean isLegacyNamedType()
```
  - toMaybeNamedType
```
public NamedType toMaybeNamedType()
```
  - isRecordType
```
public boolean isRecordType()
```
    Description copied from interface: TypeI
    
    Whether this type represents an anonymous structural type, e.g., { a: number, b: string }. Returns false for named structural types (i.e., types defined using @record).
    
    Specified by:
    
    isRecordType in interface TypeI
  - isStructuralInterface
```
public boolean isStructuralInterface()
```
    Specified by:
    
    isStructuralInterface in interface TypeI
  - isStructuralType
```
public boolean isStructuralType()
```
  - toMaybeRecordType
```
public RecordType toMaybeRecordType()
```
    Downcasts this to a RecordType, or returns null if this is not a RecordType.
  - isTemplatizedType
```
public final boolean isTemplatizedType()
```
  - isGenericObjectType
```
public final boolean isGenericObjectType()
```
    Description copied from interface: TypeI
    
    True if this type represents a generic object (non function) type, instantiated or not.
    
    Specified by:
    
    isGenericObjectType in interface TypeI
  - toMaybeTemplatizedType
```
public TemplatizedType toMaybeTemplatizedType()
```
    Downcasts this to a TemplatizedType, or returns null if this is not a function.
  - isTemplateType
```
public final boolean isTemplateType()
```
  - isTypeVariable
```
public final boolean isTypeVariable()
```
    Specified by:
    
    isTypeVariable in interface TypeI
  - toMaybeTemplateType
```
public TemplateType toMaybeTemplateType()
```
    Downcasts this to a TemplateType, or returns null if this is not a function.
  - hasAnyTemplateTypes
```
public boolean hasAnyTemplateTypes()
```
  - getTemplateTypeMap
```
public TemplateTypeMap getTemplateTypeMap()
```
    Returns the template type map associated with this type.
  - extendTemplateTypeMap
```
public void extendTemplateTypeMap(TemplateTypeMap otherMap)
```
    Extends the template type map associated with this type, merging in the keys and values of the specified map.
  - isObject
```
public boolean isObject()
```
    Tests whether this type is an Object, or any subtype thereof.
    
    Returns:
    
    this <: Object
  - isObjectType
```
public final boolean isObjectType()
```
    Specified by:
    
    isObjectType in interface TypeI
  - isInstanceofObject
```
public final boolean isInstanceofObject()
```
    Description copied from interface: TypeI
    
    True when the nominal type of this type is Object. The name is not great, because objects with a different nominal type can flow to places that treat them as Object. But I'm not sure what a better name would be.
    
    Specified by:
    
    isInstanceofObject in interface TypeI
  - isConstructor
```
public boolean isConstructor()
```
    Whether this type is a FunctionType that is a constructor or a named type that points to such a type.
    
    Specified by:
    
    isConstructor in interface TypeI
  - isNominalType
```
public boolean isNominalType()
```
    Whether this type is a nominal type (a named instance object or a named enum).
  - isNominalConstructor
```
public final boolean isNominalConstructor()
```
    Whether this type is the original constructor of a nominal type. Does not include structural constructors.
  - isInstanceType
```
public boolean isInstanceType()
```
    Whether this type is an Instance object of some constructor. Does not necessarily mean this is an InstanceObjectType.
  - isInterface
```
public boolean isInterface()
```
    Whether this type is a FunctionType that is an interface or a named type that points to such a type.
    
    Specified by:
    
    isInterface in interface TypeI
  - isOrdinaryFunction
```
public boolean isOrdinaryFunction()
```
    Whether this type is a FunctionType that is an ordinary function or a named type that points to such a type.
  - isEquivalentTo
```
public final boolean isEquivalentTo(TypeI that)
```
    Checks if two types are equivalent.
    
    Specified by:
    
    isEquivalentTo in interface TypeI
  - isEquivalentTo
```
public final boolean isEquivalentTo(TypeI that,
                                    boolean isStructural)
```
  - differsFrom
```
public final boolean differsFrom(JSType that)
```
    Whether this type is meaningfully different from that type for the purposes of data flow analysis. This is a trickier check than pure equality, because it has to properly handle unknown types. See EquivalenceMethod for more info.
    
    See Also:
    
    Unknown unknowns
  - isEquivalent
```
public static boolean isEquivalent(JSType typeA,
                                   JSType typeB)
```
  - equals
```
public boolean equals(Object jsType)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public abstract int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - matchesInt32Context
```
public final boolean matchesInt32Context()
```
    This predicate is used to test whether a given type can appear in a 'Int32' context. This context includes, for example, the operands of a bitwise or operator. Since we do not currently support integer types, this is a synonym for Number.
  - matchesUint32Context
```
public final boolean matchesUint32Context()
```
    This predicate is used to test whether a given type can appear in a 'Uint32' context. This context includes the right-hand operand of a shift operator.
  - matchesNumberContext
```
public boolean matchesNumberContext()
```
    This predicate is used to test whether a given type can appear in a numeric context, such as an operand of a multiply operator.
  - matchesStringContext
```
public boolean matchesStringContext()
```
    This predicate is used to test whether a given type can appear in a String context, such as an operand of a string concat (+) operator. All types have at least the potential for converting to String. When we add externally defined types, such as a browser OM, we may choose to add types that do not automatically convert to String.
  - matchesObjectContext
```
public boolean matchesObjectContext()
```
    This predicate is used to test whether a given type can appear in an Object context, such as the expression in a with statement. Most types we will encounter, except notably null, have at least the potential for converting to Object. Host defined objects can get peculiar.
  - findPropertyType
```
public JSType findPropertyType(String propertyName)
```
    Coerces this type to an Object type, then gets the type of the property whose name is given. Unlike ObjectType.getPropertyType(java.lang.String), returns null if the property is not found.
    
    Returns:
    
    The property's type. null if the current type cannot have properties, or if the type is not found.
  - canBeCalled
```
public boolean canBeCalled()
```
    This predicate is used to test whether a given type can be used as the 'function' in a function call.
    
    Returns:
    
    true if this type might be callable.
  - canCastTo
```
public boolean canCastTo(JSType that)
```
    Tests whether values of this type can be safely assigned to values of that type.
    The default implementation verifies that this is a subtype of that.
  - autoboxesTo
```
public JSType autoboxesTo()
```
    Turn a scalar type to the corresponding object type.
    
    Returns:
    
    the auto-boxed type or null if this type is not a scalar.
  - isBoxableScalar
```
public boolean isBoxableScalar()
```
    Specified by:
    
    isBoxableScalar in interface TypeI
  - unboxesTo
```
public JSType unboxesTo()
```
    Turn an object type to its corresponding scalar type.
    
    Returns:
    
    the unboxed type or null if this type does not unbox.
  - toObjectType
```
public ObjectType toObjectType()
```
    Casts this to an ObjectType, or returns null if this is not an ObjectType. If this is a scalar type, it will *not* be converted to an object type. If you want to simulate JS autoboxing or dereferencing, you should use autoboxesTo() or dereference().
  - autobox
```
public JSType autobox()
```
    Dereference a type for property access. Filters null/undefined and autoboxes the resulting type. Never returns null.
    
    Specified by:
    
    autobox in interface TypeI
  - dereference
```
public final ObjectType dereference()
```
    Dereference a type for property access. Filters null/undefined, autoboxes the resulting type, and returns it iff it's an object.
  - autoboxAndGetObject
```
public final ObjectType autoboxAndGetObject()
```
    Specified by:
    
    autoboxAndGetObject in interface TypeI
  - canTestForEqualityWith
```
public final boolean canTestForEqualityWith(JSType that)
```
    Tests whether this and that are meaningfully comparable. By meaningfully, we mean compatible types that do not lead to step 22 of the definition of the Abstract Equality Comparison Algorithm (11.9.3, page 55–56) of the ECMA-262 specification.
  - testForEquality
```
public TernaryValue testForEquality(JSType that)
```
    Compares this and that.
    Returns:
    TernaryValue.TRUE if the comparison of values of this type and that always succeed (such as undefined compared to null)
    
    TernaryValue.FALSE if the comparison of values of this type and that always fails (such as undefined compared to number)
    
    TernaryValue.UNKNOWN if the comparison can succeed or fail depending on the concrete values
  - canTestForShallowEqualityWith
```
public final boolean canTestForShallowEqualityWith(JSType that)
```
    Tests whether this and that are meaningfully comparable using shallow comparison. By meaningfully, we mean compatible types that are not rejected by step 1 of the definition of the Strict Equality Comparison Algorithm (11.9.6, page 56–57) of the ECMA-262 specification.
  - isNullable
```
public boolean isNullable()
```
    Tests whether this type is nullable.
    
    Specified by:
    
    isNullable in interface TypeI
  - isVoidable
```
public boolean isVoidable()
```
    Tests whether this type is voidable.
    
    Specified by:
    
    isVoidable in interface TypeI
  - isExplicitlyVoidable
```
public boolean isExplicitlyVoidable()
```
    Tests whether this type explicitly allows undefined, as opposed to ? or *. This is required for a property to be optional.
  - collapseUnion
```
public JSType collapseUnion()
```
    Gets the least supertype of this that's not a union.
  - getLeastSupertype
```
public JSType getLeastSupertype(JSType that)
```
    Gets the least supertype of this and that. The least supertype is the join (∨) or supremum of both types in the type lattice.
    Examples:
    - number ∨ * = *
    - number ∨ Object = (number, Object)
    - Number ∨ Object = Object
    Returns:
    
    this ∨ that
  - getGreatestSubtype
```
public JSType getGreatestSubtype(JSType that)
```
    Gets the greatest subtype of this and that. The greatest subtype is the meet (∧) or infimum of both types in the type lattice.
    Examples
    - Number ∧ Any = Any
    - number ∧ Object = Any
    - Number ∧ Object = Number
    Returns:
    
    this ∨ that
  - meetWith
```
public TypeI meetWith(TypeI that)
```
    Specified by:
    
    meetWith in interface TypeI
  - getRestrictedTypeGivenToBooleanOutcome
```
public JSType getRestrictedTypeGivenToBooleanOutcome(boolean outcome)
```
    Computes the restricted type of this type knowing that the ToBoolean predicate has a specific value. For more information about the ToBoolean predicate, see getPossibleToBooleanOutcomes().
    
    Parameters:
    
    outcome - the value of the ToBoolean predicate
    
    Returns:
    
    the restricted type, or the Any Type if the underlying type could not have yielded this ToBoolean value TODO(user): Move this method to the SemanticRAI and use the visit method of types to get the restricted type.
  - getPossibleToBooleanOutcomes
```
public abstract BooleanLiteralSet getPossibleToBooleanOutcomes()
```
    Computes the set of possible outcomes of the ToBoolean predicate for this type. The ToBoolean predicate is defined by the ECMA-262 standard, 3^rd edition. Its behavior for simple types can be summarized by the following table:
    
    type result
    
    undefined {false}
    
    null {false}
    
    boolean {true, false}
    
    number {true, false}
    
    string {true, false}
    
    Object {true}
    
    Returns:
    
    the set of boolean literals for this type
  - getTypesUnderEquality
```
public JSType.TypePair getTypesUnderEquality(JSType that)
```
    Computes the subset of this and that types if equality is observed. If a value v1 of type null is equal to a value v2 of type (undefined,number), we can infer that the type of v1 is null and the type of v2 is undefined.
    
    Returns:
    
    a pair containing the restricted type of this as the first component and the restricted type of that as the second element. The returned pair is never null even though its components may be null
  - getTypesUnderInequality
```
public JSType.TypePair getTypesUnderInequality(JSType that)
```
    Computes the subset of this and that types if inequality is observed. If a value v1 of type number is not equal to a value v2 of type (undefined,number), we can infer that the type of v1 is number and the type of v2 is number as well.
    
    Returns:
    
    a pair containing the restricted type of this as the first component and the restricted type of that as the second element. The returned pair is never null even though its components may be null
  - getTypesUnderShallowEquality
```
public JSType.TypePair getTypesUnderShallowEquality(JSType that)
```
    Computes the subset of this and that types under shallow equality.
    
    Returns:
    
    a pair containing the restricted type of this as the first component and the restricted type of that as the second element. The returned pair is never null even though its components may be null.
  - getTypesUnderShallowInequality
```
public JSType.TypePair getTypesUnderShallowInequality(JSType that)
```
    Computes the subset of this and that types under shallow inequality.
    
    Returns:
    
    A pair containing the restricted type of this as the first component and the restricted type of that as the second element. The returned pair is never null even though its components may be null
  - getUnionMembers
```
public Iterable<JSType> getUnionMembers()
```
    Description copied from interface: TypeI
    
    If this type is a union type, returns a list of its members. Otherwise returns null.
    
    Specified by:
    
    getUnionMembers in interface TypeI
  - restrictByNotNullOrUndefined
```
public JSType restrictByNotNullOrUndefined()
```
    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
  - isSubtypeWithoutStructuralTyping
```
public boolean isSubtypeWithoutStructuralTyping(TypeI that)
```
    the logic of this method is similar to isSubtype, except that it does not perform structural interface matching This function is added for disambiguate properties, and is deprecated for the other use cases.
    
    Specified by:
    
    isSubtypeWithoutStructuralTyping in interface TypeI
  - isSubtype
```
public boolean isSubtype(JSType that)
```
    Checks whether this is a subtype of that.
    Note this function also returns true if this type structurally matches the protocol define by that type (if that type is an interface function type) Subtyping rules:
    - (unknown) — every type is a subtype of the Unknown type.
    - (no) — the No type is a subtype of every type.
    - (no-object) — the NoObject type is a subtype of every object type (i.e. subtypes of the Object type).
    - (ref) — a type is a subtype of itself.
    - (union-l) — A union type is a subtype of a type U if all the union type's constituents are a subtype of U. Formally
      (T₁, …, T_n) <: U if and only T_k <: U for all k ∈ 1..n.
    - (union-r) — A type U is a subtype of a union type if it is a subtype of one of the union type's constituents. Formally
      U <: (T₁, …, T_n) if and only if U <: T_k for some index k.
    - (objects) — an Object O₁ is a subtype of an object O₂ if it has more properties than O₂ and all common properties are pairwise subtypes.
    Returns:
    
    this <: that
  - isSubtype
```
public boolean isSubtype(JSType that,
                         JSType.SubtypingMode mode)
```
  - isSubtype
```
protected boolean isSubtype(JSType that,
                            com.google.javascript.rhino.jstype.JSType.ImplCache implicitImplCache,
                            JSType.SubtypingMode subtypingMode)
```
    checking isSubtype with structural interface matching
    
    Parameters:
    
    implicitImplCache - a cache that records the checked or currently checking type pairs, for example, if previous checking found that constructor C is a subtype of interface I, then in the cache, table key <I,C> maps to IMPLEMENT status.
  - visit
```
public abstract <T> T visit(Visitor<T> visitor)
```
    Visit this type with the given visitor.
    
    Returns:
    
    the value returned by the visitor
    
    See Also:
    
    Visitor
  - resolve
```
public final JSType resolve(ErrorReporter t,
                            StaticTypedScope<JSType> scope)
```
    Resolve this type in the given scope. The returned value must be equal to this, as defined by isEquivalentTo(com.google.javascript.rhino.TypeI). It may or may not be the same object. This method may modify the internal state of this, as long as it does so in a way that preserves Object equality. For efficiency, we should only resolve a type once per compilation job. For incremental compilations, one compilation job may need the artifacts from a previous generation, so we will eventually need a generational flag instead of a boolean one.
  - isResolved
```
public final boolean isResolved()
```
    Whether the type has been resolved.
  - setValidator
```
public boolean setValidator(com.google.common.base.Predicate<JSType> validator)
```
    Certain types have constraints on them at resolution-time. For example, a type in an @extends annotation must be an object. Clients should inject a validator that emits a warning if the type does not validate, and return false.
  - toString
```
public String toString()
```
    A string representation of this type, suitable for printing in warnings.
    
    Overrides:
    
    toString in class Object
  - toDebugHashCodeString
```
public String toDebugHashCodeString()
```
    A hash code function for diagnosing complicated issues around type-identity.
  - toAnnotationString
```
public final String toAnnotationString()
```
    A string representation of this type, suitable for printing in type annotations at code generation time. Don't call from this package; use appendAsNonNull instead.
    
    Specified by:
    
    toAnnotationString in interface TypeI
  - toNonNullAnnotationString
```
public final String toNonNullAnnotationString()
```
    Description copied from interface: TypeI
    
    Returns a string representation of this type, suitable for printing in type annotations at code generation time. In particular, explicit non-null modifiers will be added to implicitly nullable types.
    
    Specified by:
    
    toNonNullAnnotationString in interface TypeI
  - matchConstraint
```
public void matchConstraint(JSType constraint)
```
    Modify this type so that it matches the specified type. This is useful for reverse type-inference, where we want to infer that an object literal matches its constraint (much like how the java compiler does reverse-inference to figure out generics).
    
    Parameters:
    
    constraint -
  - isSubtypeOf
```
public boolean isSubtypeOf(TypeI other)
```
    Specified by:
    
    isSubtypeOf in interface TypeI
  - isBottom
```
public final boolean isBottom()
```
    Specified by:
    
    isBottom in interface TypeI
  - toMaybeObjectType
```
public ObjectType 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

type	result
`undefined`	{false}
`null`	{false}
`boolean`	{true, false}
`number`	{true, false}
`string`	{true, false}
`Object`	{true}

Class JSType

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

templateTypeMap

Method Detail

getJSDocInfo

getDisplayName

hasDisplayName

hasProperty

isNoType

isNoResolvedType

isUnresolved

isUnresolvedOrResolvedUnknown

isNoObjectType

isEmptyType

isNumberObjectType

isNumberValueType

isFunctionPrototypeType

isPrototypeObject

isStringObjectType

isStringValueType

isString

isNumber

isArrayType

isBooleanObjectType

isBooleanValueType

isRegexpType

isDateType

isNullType

isVoidType

isAllType

isTop

isUnknownType

isSomeUnknownType

isCheckedUnknownType

isUnionType

hasUninstantiatedTypeVariables

containsArray

isStruct

isDict

isLiteralObject

getGreatestSubtypeWithProperty

toMaybeUnionType

isGlobalThisType

isFunctionType

toMaybeFunctionType

toMaybeFunctionType

isEnumElementType

isEnumElement

getEnumeratedTypeOfEnumElement

toMaybeEnumElementType

isEnumType

isEnumObject

toMaybeEnumType

isNamedType

isLegacyNamedType

toMaybeNamedType

isRecordType

isStructuralInterface

isStructuralType

toMaybeRecordType

isTemplatizedType

isGenericObjectType

toMaybeTemplatizedType

isTemplateType

isTypeVariable

toMaybeTemplateType

hasAnyTemplateTypes

getTemplateTypeMap

extendTemplateTypeMap

isObject

isObjectType

isInstanceofObject

isConstructor

isNominalType

isNominalConstructor

isInstanceType