TypeInfo (HtmlUnit JavaScript Engine 4.16.0 API)

All Known Subinterfaces:

ParameterizedTypeInfo, VariableTypeInfo, WildcardTypeInfo

All Known Implementing Classes:

ArrayTypeInfo, BasicClassTypeInfo, ClassTypeInfo, EnumTypeInfo, InterfaceTypeInfo, NoTypeInfo, ParameterizedTypeInfoImpl, PrimitiveClassTypeInfo, TypeInfoBase, VariableTypeInfoImpl
```
public interface TypeInfo
```
A representation of Java type, aiming at preserving more type information than what a Class can provide
Note: using null is not recommended, NONE should be used instead

See Also:

: how to convert TypeInfo back to Class, : how to determine whether a TypeInfo represents a specific class

Field Summary

Fields
Modifier and Type	Field and Description
`static TypeInfo`	`BIG_INT`
`static TypeInfo`	`BOOLEAN`
`static TypeInfo`	`BYTE`
`static TypeInfo`	`CHARACTER`
`static TypeInfo`	`DATE`
`static TypeInfo`	`DOUBLE`
`static TypeInfo`	`FLOAT`
`static TypeInfo`	`INT`
`static TypeInfo`	`LONG`
`static TypeInfo`	`NONE`
`static TypeInfo`	`NUMBER`
`static TypeInfo`	`OBJECT` use `isObjectExact()` to determine whether a type represents a `Object` class, using `typeInfo == TypeInfo.OBJECT` might cause problem with `VariableTypeInfo`
`static TypeInfo`	`OBJECT_ARRAY`
`static TypeInfo`	`PRIMITIVE_BOOLEAN`
`static TypeInfo`	`PRIMITIVE_BYTE`
`static TypeInfo`	`PRIMITIVE_CHARACTER`
`static TypeInfo`	`PRIMITIVE_DOUBLE`
`static TypeInfo`	`PRIMITIVE_FLOAT`
`static TypeInfo`	`PRIMITIVE_INT`
`static TypeInfo`	`PRIMITIVE_LONG`
`static TypeInfo`	`PRIMITIVE_SHORT`
`static TypeInfo`	`PRIMITIVE_VOID`
`static TypeInfo`	`RAW_CLASS`
`static TypeInfo`	`RAW_CONSUMER`
`static TypeInfo`	`RAW_ENUM_SET`
`static TypeInfo`	`RAW_FUNCTION`
`static TypeInfo`	`RAW_LIST`
`static TypeInfo`	`RAW_MAP`
`static TypeInfo`	`RAW_OPTIONAL`
`static TypeInfo`	`RAW_PREDICATE`
`static TypeInfo`	`RAW_SET`
`static TypeInfo`	`RAW_SUPPLIER`
`static TypeInfo`	`RUNNABLE`
`static TypeInfo`	`SHORT`
`static TypeInfo`	`STRING`
`static TypeInfo`	`STRING_ARRAY`
`static TypeInfo`	`VOID`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`append(TypeFormatContext ctx, StringBuilder builder)`
`Class<?>`	`asClass()` Get the `Class` object represented by this `TypeInfo`.
`default void`	`collectComponentClass(Consumer<Class<?>> collector)`
`default TypeInfo`	`consolidate(Map<VariableTypeInfo,TypeInfo> mapping)`
`default Object`	`createDefaultValue()`
`default List<Object>`	`enumConstants()`
`default TypeInfo`	`getComponentType()`
`default int`	`getTypeTag()`
`default boolean`	`is(Class<?> c)`
`default boolean`	`isArray()`
`default boolean`	`isAssignableFrom(TypeInfo another)`
`default boolean`	`isBoolean()`
`default boolean`	`isByte()`
`default boolean`	`isCharacter()`
`default boolean`	`isDouble()`
`default boolean`	`isEnum()`
`default boolean`	`isFloat()`
`default boolean`	`isFunctionalInterface()`
`default boolean`	`isInstance(Object o)`
`default boolean`	`isInt()`
`default boolean`	`isInterface()`
`default boolean`	`isLong()`
`default boolean`	`isNot(Class<?> c)`
`default boolean`	`isNumber()`
`default boolean`	`isObjectExact()`
`default boolean`	`isPrimitive()`
`default boolean`	`isShort()`
`default boolean`	`isString()`
`default boolean`	`isVoid()`
`default Object`	`newArray(int length)` get an array whose element type is the caller TypeInfo
`default TypeInfo`	`param(int index)` Example: 1. for `Map<String, Integer>`, `param(-1)` == `NONE`, `param(0)` == `STRING`, `param(1)` == `INT`, `param(2)` == `NONE` 2. for `Map` (raw usage of generic class) or `Integer` (not generic class), `param(anyNumberHere)` == `NONE`
`default boolean`	`shouldConvert()`
`String`	`toString()`

- Field Detail
  - NONE
```
static final TypeInfo NONE
```
  - OBJECT
```
static final TypeInfo OBJECT
```
    use isObjectExact() to determine whether a type represents a Object class, using `typeInfo == TypeInfo.OBJECT` might cause problem with VariableTypeInfo
  - OBJECT_ARRAY
```
static final TypeInfo OBJECT_ARRAY
```
  - PRIMITIVE_VOID
```
static final TypeInfo PRIMITIVE_VOID
```
  - PRIMITIVE_BOOLEAN
```
static final TypeInfo PRIMITIVE_BOOLEAN
```
  - PRIMITIVE_BYTE
```
static final TypeInfo PRIMITIVE_BYTE
```
  - PRIMITIVE_SHORT
```
static final TypeInfo PRIMITIVE_SHORT
```
  - PRIMITIVE_INT
```
static final TypeInfo PRIMITIVE_INT
```
  - PRIMITIVE_LONG
```
static final TypeInfo PRIMITIVE_LONG
```
  - PRIMITIVE_FLOAT
```
static final TypeInfo PRIMITIVE_FLOAT
```
  - PRIMITIVE_DOUBLE
```
static final TypeInfo PRIMITIVE_DOUBLE
```
  - PRIMITIVE_CHARACTER
```
static final TypeInfo PRIMITIVE_CHARACTER
```
  - VOID
```
static final TypeInfo VOID
```
  - BOOLEAN
```
static final TypeInfo BOOLEAN
```
  - BYTE
```
static final TypeInfo BYTE
```
  - SHORT
```
static final TypeInfo SHORT
```
  - INT
```
static final TypeInfo INT
```
  - LONG
```
static final TypeInfo LONG
```
  - FLOAT
```
static final TypeInfo FLOAT
```
  - DOUBLE
```
static final TypeInfo DOUBLE
```
  - CHARACTER
```
static final TypeInfo CHARACTER
```
  - NUMBER
```
static final TypeInfo NUMBER
```
  - STRING
```
static final TypeInfo STRING
```
  - STRING_ARRAY
```
static final TypeInfo STRING_ARRAY
```
  - RAW_CLASS
```
static final TypeInfo RAW_CLASS
```
  - DATE
```
static final TypeInfo DATE
```
  - RUNNABLE
```
static final TypeInfo RUNNABLE
```
  - RAW_CONSUMER
```
static final TypeInfo RAW_CONSUMER
```
  - RAW_SUPPLIER
```
static final TypeInfo RAW_SUPPLIER
```
  - RAW_FUNCTION
```
static final TypeInfo RAW_FUNCTION
```
  - RAW_PREDICATE
```
static final TypeInfo RAW_PREDICATE
```
  - RAW_LIST
```
static final TypeInfo RAW_LIST
```
  - RAW_SET
```
static final TypeInfo RAW_SET
```
  - RAW_MAP
```
static final TypeInfo RAW_MAP
```
  - RAW_OPTIONAL
```
static final TypeInfo RAW_OPTIONAL
```
  - RAW_ENUM_SET
```
static final TypeInfo RAW_ENUM_SET
```
  - BIG_INT
```
static final TypeInfo BIG_INT
```
- Method Detail
  - asClass
```
Class<?> asClass()
```
    Get the Class object represented by this TypeInfo. For a Type object, the TypeInfo object created from the Type object should return the exact same class as the one after Java erased its generic type info
  - param
```
default TypeInfo param(int index)
```
    Example:
    1. for Map<String, Integer>, param(-1) == NONE, param(0) == STRING, param(1) == INT, param(2) == NONE
    2. for Map (raw usage of generic class) or Integer (not generic class), param(anyNumberHere) == NONE
    
    Returns:
    
    the actual type parameter at provided index, or NONE if:
    1. index not in valid range, or
    2. the TypeInfo itself is not representing a ParameterizedType
    
    See Also:
    
    ParameterizedTypeInfo.params()
  - is
```
default boolean is(Class<?> c)
```
    Returns:
    
    true if this TypeInfo represents the same class as the Class parameter, false otherwise
  - isNot
```
default boolean isNot(Class<?> c)
```
    Returns:
    
    true if this TypeInfo does NOT represent the same class as the Class parameter, false otherwise
  - isPrimitive
```
default boolean isPrimitive()
```
    See Also:
    
    Class.isPrimitive()
  - shouldConvert
```
default boolean shouldConvert()
```
  - toString
```
String toString()
```
    Overrides:
    
    toString in class Object
    
    See Also:
    
    append(TypeFormatContext, StringBuilder)
  - append
```
void append(TypeFormatContext ctx,
            StringBuilder builder)
```
  - getComponentType
```
default TypeInfo getComponentType()
```
    See Also:
    
    Class.getComponentType()
  - newArray
```
default Object newArray(int length)
```
    get an array whose element type is the caller TypeInfo
  - isInterface
```
default boolean isInterface()
```
    See Also:
    
    Class.isInterface()
  - isFunctionalInterface
```
default boolean isFunctionalInterface()
```
    See Also:
    
    FunctionalInterface
  - isEnum
```
default boolean isEnum()
```
    See Also:
    
    Class.isEnum()
  - enumConstants
```
default List<Object> enumConstants()
```
    See Also:
    
    Class.getEnumConstants()
  - createDefaultValue
```
default Object createDefaultValue()
```
  - isVoid
```
default boolean isVoid()
```
    Returns:
    
    true if this TypeInfo represents Void class or void class
  - isBoolean
```
default boolean isBoolean()
```
    Returns:
    
    true if this TypeInfo represents Boolean class or boolean class
  - isNumber
```
default boolean isNumber()
```
    Returns:
    
    true if this TypeInfo represents a type assignable to Number class
    
    See Also:
    
    isAssignableFrom(TypeInfo)
  - isByte
```
default boolean isByte()
```
    Returns:
    
    true if this TypeInfo represents Byte class or byte class
  - isShort
```
default boolean isShort()
```
    Returns:
    
    true if this TypeInfo represents Short class or short class
  - isInt
```
default boolean isInt()
```
    Returns:
    
    true if this TypeInfo represents Integer class or int class
  - isLong
```
default boolean isLong()
```
    Returns:
    
    true if this TypeInfo represents Long class or long class
  - isFloat
```
default boolean isFloat()
```
    Returns:
    
    true if this TypeInfo represents Float class or float class
  - isDouble
```
default boolean isDouble()
```
    Returns:
    
    true if this TypeInfo represents Double class or double class
  - isCharacter
```
default boolean isCharacter()
```
    Returns:
    
    true if this TypeInfo represents Character class or char class
  - isString
```
default boolean isString()
```
    Returns:
    
    true if this TypeInfo represents String class
  - isObjectExact
```
default boolean isObjectExact()
```
    Returns:
    
    true if this TypeInfo represents Object class
  - collectComponentClass
```
default void collectComponentClass(Consumer<Class<?>> collector)
```
  - isArray
```
default boolean isArray()
```
    See Also:
    
    Class.isArray()
  - isAssignableFrom
```
default boolean isAssignableFrom(TypeInfo another)
```
    Returns:
    
    true if the caller TypeInfo represents the super class of the class represented by another TypeInfo
    
    See Also:
    
    Class.isAssignableFrom(Class)
  - isInstance
```
default boolean isInstance(Object o)
```
    Returns:
    
    true if o is an instance of this class represented by the caller TypeInfo
    
    See Also:
    
    Class.isInstance(Object)
  - getTypeTag
```
default int getTypeTag()
```
    See Also:
    
    FunctionObject.getTypeTag(Class)
  - consolidate
```
default TypeInfo consolidate(Map<VariableTypeInfo,TypeInfo> mapping)
```

Interface TypeInfo

Field Summary

Method Summary

Field Detail

NONE

OBJECT

OBJECT_ARRAY

PRIMITIVE_VOID

PRIMITIVE_BOOLEAN

PRIMITIVE_BYTE

PRIMITIVE_SHORT

PRIMITIVE_INT

PRIMITIVE_LONG

PRIMITIVE_FLOAT

PRIMITIVE_DOUBLE

PRIMITIVE_CHARACTER

VOID

BOOLEAN

BYTE

SHORT

INT

LONG

FLOAT

DOUBLE

CHARACTER

NUMBER

STRING

STRING_ARRAY

RAW_CLASS

DATE

RUNNABLE

RAW_CONSUMER

RAW_SUPPLIER

RAW_FUNCTION

RAW_PREDICATE

RAW_LIST

RAW_SET

RAW_MAP

RAW_OPTIONAL

RAW_ENUM_SET

BIG_INT

Method Detail

asClass

param

is

isNot

isPrimitive

shouldConvert

toString

append

getComponentType

newArray

isInterface

isFunctionalInterface

isEnum

enumConstants

createDefaultValue

isVoid

isBoolean

isNumber

isByte

isShort

isInt

isLong

isFloat

isDouble

isCharacter

isString

isObjectExact

collectComponentClass

isArray

isAssignableFrom

isInstance

getTypeTag

consolidate