TypeI (Closure Compiler v20170910 API)

All Superinterfaces:

Serializable

All Known Subinterfaces:

FunctionTypeI, ObjectTypeI

All Known Implementing Classes:

AllType, BooleanType, EnumElementType, EnumType, FunctionType, JSType, JSType, NamedType, NoObjectType, NoResolvedType, NoType, NullType, NumberType, ObjectType, PrototypeObjectType, ProxyObjectType, RecordType, StringType, TemplateType, TemplatizedType, UnionType, UnknownType, VoidType
```
public interface TypeI
extends Serializable
```
A common interface for types in the old type system and the new type system, so that the other passes need not know which type system they are using.

Author:

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

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`TypeI.Nullability` Specifies how to express nullability of reference types in annotation strings and error messages.
`static class`	`TypeI.TypeInference` Simple enum to easily identify the type of TypeI instance.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`TypeI`	`autobox()`
`ObjectTypeI`	`autoboxAndGetObject()`
`boolean`	`containsArray()`
`String`	`getDisplayName()`
`TypeI`	`getEnumeratedTypeOfEnumElement()`
`TypeI`	`getGreatestSubtypeWithProperty(String propName)`
`JSDocInfo`	`getJSDocInfo()`
`Collection<TypeI>`	`getTypeParameters()` If this type is a generic nominal type or function, return the type parameters as type variables.
`Iterable<? extends TypeI>`	`getUnionMembers()` If this type is a union type, returns a list of its members.
`boolean`	`isBooleanValueType()` Whether the type is a scalar boolean.
`boolean`	`isBottom()`
`boolean`	`isBoxableScalar()`
`boolean`	`isConstructor()`
`boolean`	`isEnumElement()`
`boolean`	`isEnumObject()`
`boolean`	`isEquivalentTo(TypeI type)`
`boolean`	`isFullyInstantiated()` Returns true if this type is a generic object (non function) and all its type variables are instantiated.
`boolean`	`isFunctionType()`
`boolean`	`isGenericObjectType()` True if this type represents a generic object (non function) type, instantiated or not.
`boolean`	`isInstanceofObject()` True when the nominal type of this type is Object.
`boolean`	`isInterface()`
`boolean`	`isLiteralObject()`
`boolean`	`isNullable()`
`boolean`	`isNullType()`
`boolean`	`isNumberValueType()` Whether the type is a scalar number.
`boolean`	`isObjectType()`
`boolean`	`isPartiallyInstantiated()` Returns true if this type is a generic object (non function) and some of its type variables are instantiated.
`boolean`	`isPrototypeObject()`
`boolean`	`isRecordType()` Whether this type represents an anonymous structural type, e.g., { a: number, b: string }.
`boolean`	`isSomeUnknownType()`
`boolean`	`isStringValueType()` Whether the type is a scalar string.
`boolean`	`isStructuralInterface()`
`boolean`	`isSubtypeOf(TypeI type)`
`boolean`	`isSubtypeWithoutStructuralTyping(TypeI type)`
`boolean`	`isTop()`
`boolean`	`isTypeVariable()`
`boolean`	`isUnionType()`
`boolean`	`isUnknownType()`
`boolean`	`isUnresolved()`
`boolean`	`isUnresolvedOrResolvedUnknown()`
`boolean`	`isVoidable()`
`boolean`	`isVoidType()`
`TypeI`	`meetWith(TypeI other)`
`TypeI`	`restrictByNotNullOrUndefined()` If this is a union type, returns a union type that does not include the null or undefined type.
`String`	`toAnnotationString(TypeI.Nullability nullability)` Returns a string representation of this type, suitable for printing in type annotations at code generation time.
`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.
`TypeI.TypeInference`	`typeInference()` Returns the type inference of this object.

- Method Detail
  - isBottom
```
boolean isBottom()
```
  - isTop
```
boolean isTop()
```
  - isTypeVariable
```
boolean isTypeVariable()
```
  - isUnresolved
```
boolean isUnresolved()
```
  - isBoxableScalar
```
boolean isBoxableScalar()
```
  - autobox
```
TypeI autobox()
```
  - isUnresolvedOrResolvedUnknown
```
boolean isUnresolvedOrResolvedUnknown()
```
  - isConstructor
```
boolean isConstructor()
```
  - isEquivalentTo
```
boolean isEquivalentTo(TypeI type)
```
  - isFunctionType
```
boolean isFunctionType()
```
  - isInterface
```
boolean isInterface()
```
    Returns:
    
    True for both nominal and structural interfaces
  - isStructuralInterface
```
boolean isStructuralInterface()
```
  - isSubtypeOf
```
boolean isSubtypeOf(TypeI type)
```
  - isSubtypeWithoutStructuralTyping
```
boolean isSubtypeWithoutStructuralTyping(TypeI type)
```
  - containsArray
```
boolean containsArray()
```
  - isUnknownType
```
boolean isUnknownType()
```
  - isSomeUnknownType
```
boolean isSomeUnknownType()
```
  - isObjectType
```
boolean isObjectType()
```
  - isGenericObjectType
```
boolean isGenericObjectType()
```
    True if this type represents a generic object (non function) type, instantiated or not.
  - isInstanceofObject
```
boolean isInstanceofObject()
```
    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.
  - isUnionType
```
boolean isUnionType()
```
  - isNullable
```
boolean isNullable()
```
  - isVoidable
```
boolean isVoidable()
```
  - isNullType
```
boolean isNullType()
```
  - isVoidType
```
boolean isVoidType()
```
  - isPrototypeObject
```
boolean isPrototypeObject()
```
  - isLiteralObject
```
boolean isLiteralObject()
```
  - isEnumElement
```
boolean isEnumElement()
```
  - isStringValueType
```
boolean isStringValueType()
```
    Whether the type is a scalar string. In OTI, the isString method returns true for String objects as well.
  - isRecordType
```
boolean isRecordType()
```
    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).
  - isNumberValueType
```
boolean isNumberValueType()
```
    Whether the type is a scalar number. In OTI, the isNumber method returns true for Number objects as well.
  - isBooleanValueType
```
boolean isBooleanValueType()
```
    Whether the type is a scalar boolean. In OTI, the isBoolean method returns true for Boolean objects as well.
  - autoboxAndGetObject
```
ObjectTypeI autoboxAndGetObject()
```
  - getJSDocInfo
```
JSDocInfo getJSDocInfo()
```
  - restrictByNotNullOrUndefined
```
TypeI restrictByNotNullOrUndefined()
```
    If this is a union type, returns a union type that does not include the null or undefined type.
  - toMaybeFunctionType
```
FunctionTypeI toMaybeFunctionType()
```
    Downcasts this to a FunctionTypeI, or returns null if this is not a function.
  - toMaybeObjectType
```
ObjectTypeI toMaybeObjectType()
```
    If this type is a single object, downcast it to ObjectTypeI. If it is a non-object or a union of objects, return null.
  - getUnionMembers
```
Iterable<? extends TypeI> getUnionMembers()
```
    If this type is a union type, returns a list of its members. Otherwise returns null.
  - meetWith
```
TypeI meetWith(TypeI other)
```
  - getDisplayName
```
String getDisplayName()
```
  - getGreatestSubtypeWithProperty
```
TypeI getGreatestSubtypeWithProperty(String propName)
```
  - getEnumeratedTypeOfEnumElement
```
TypeI getEnumeratedTypeOfEnumElement()
```
  - isEnumObject
```
boolean isEnumObject()
```
  - isFullyInstantiated
```
boolean isFullyInstantiated()
```
    Returns true if this type is a generic object (non function) and *all* its type variables are instantiated.
  - isPartiallyInstantiated
```
boolean isPartiallyInstantiated()
```
    Returns true if this type is a generic object (non function) and *some* of its type variables are instantiated. In NTI, this is the same as isFullyInstantiated. In OTI, generic types can be partially instantiated (bad implementation choice).
  - getTypeParameters
```
Collection<TypeI> getTypeParameters()
```
    If this type is a generic nominal type or function, return the type parameters as type variables.
  - toAnnotationString
```
String toAnnotationString(TypeI.Nullability nullability)
```
    Returns a string representation of this type, suitable for printing in type annotations at code generation time.
  - typeInference
```
TypeI.TypeInference typeInference()
```
    Returns the type inference of this object. Useful for debugging. Note: this should be deleted when OTI is no longer relevant.

Interface TypeI

Nested Class Summary

Method Summary

Method Detail

isBottom

isTop

isTypeVariable

isUnresolved

isBoxableScalar

autobox

isUnresolvedOrResolvedUnknown

isConstructor

isEquivalentTo

isFunctionType

isInterface

isStructuralInterface

isSubtypeOf

isSubtypeWithoutStructuralTyping

containsArray

isUnknownType

isSomeUnknownType

isObjectType

isGenericObjectType

isInstanceofObject

isUnionType

isNullable

isVoidable

isNullType

isVoidType

isPrototypeObject

isLiteralObject

isEnumElement

isStringValueType

isRecordType

isNumberValueType

isBooleanValueType

autoboxAndGetObject

getJSDocInfo

restrictByNotNullOrUndefined

toMaybeFunctionType

toMaybeObjectType

getUnionMembers

meetWith

getDisplayName

getGreatestSubtypeWithProperty

getEnumeratedTypeOfEnumElement

isEnumObject

isFullyInstantiated

isPartiallyInstantiated

getTypeParameters

toAnnotationString

typeInference