DfTypes (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.codeInspection.dataFlow.types.DfTypes

public class DfTypes
extends java.lang.Object

Commonly used types and factory methods

Field Summary

Fields
Modifier and Type	Field and Description
`static DfBooleanType`	`BOOLEAN` A type that corresponds to JVM boolean type.
`static DfType`	`BOTTOM` A type that contains no values
`static DfDoubleType`	`DOUBLE` A type that corresponds to JVM double type
`static DfType`	`FAIL` A special value that represents a contract failure after method return (the control flow should immediately proceed with exception handling).
`static com.intellij.codeInspection.dataFlow.types.DfBooleanConstantType`	`FALSE` A false boolean constant
`static DfFloatType`	`FLOAT` A type that corresponds to JVM float type
`static DfIntType`	`INT` A type that corresponds to JVM int type
`static DfReferenceType`	`LOCAL_OBJECT` A reference type that contains any reference to a local object
`static DfLongType`	`LONG` A type that corresponds to JVM long type
`static DfReferenceType`	`NOT_NULL_OBJECT` A reference type that contains any reference except null
`static DfNullConstantType`	`NULL` A reference type that contains only null reference
`static DfReferenceType`	`OBJECT_OR_NULL` A reference type that contains any reference or null
`static DfType`	`TOP` A type that contains every possible value supported by the type system
`static com.intellij.codeInspection.dataFlow.types.DfBooleanConstantType`	`TRUE` A true boolean constant

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static com.intellij.codeInspection.dataFlow.types.DfBooleanConstantType`	`booleanValue(boolean value)`
`static DfConstantType<?>`	`constant(java.lang.Object constant, PsiType type)` Returns a custom constant type
`static DfReferenceType`	`customObject(TypeConstraint constraint, DfaNullability nullability, Mutability mutability, SpecialField specialField, DfType sfType)` A low-level method to construct a custom reference type.
`static DfConstantType<?>`	`defaultValue(PsiType type)`
`static com.intellij.codeInspection.dataFlow.types.DfDoubleConstantType`	`doubleValue(double value)`
`static com.intellij.codeInspection.dataFlow.types.DfFloatConstantType`	`floatValue(float value)`
`static DfType`	`intRange(LongRangeSet range)` Creates a type that represents a subset of int values.
`static DfType`	`intRangeClamped(LongRangeSet range)` Creates a type that represents a subset of int values, clamping values not representable in the JVM int type.
`static com.intellij.codeInspection.dataFlow.types.DfIntConstantType`	`intValue(int value)`
`static DfType`	`longRange(LongRangeSet range)` Creates a type that represents a subset of long values.
`static com.intellij.codeInspection.dataFlow.types.DfLongConstantType`	`longValue(long value)`
`static DfType`	`rangeClamped(LongRangeSet range, boolean isLong)` A convenience selector method to call `longRange(LongRangeSet)` or `intRangeClamped(LongRangeSet)`
`static DfType`	`typedObject(PsiType type, Nullability nullability)`

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

- Field Detail
  - TOP
```
public static final DfType TOP
```
    A type that contains every possible value supported by the type system
  - BOTTOM
```
public static final DfType BOTTOM
```
    A type that contains no values
  - FAIL
```
public static final DfType FAIL
```
    A special value that represents a contract failure after method return (the control flow should immediately proceed with exception handling). This value is like a constant but it's type doesn't correspond to any JVM type.
  - BOOLEAN
```
public static final DfBooleanType BOOLEAN
```
    A type that corresponds to JVM boolean type. Contains two values: true and false
  - TRUE
```
public static final com.intellij.codeInspection.dataFlow.types.DfBooleanConstantType TRUE
```
    A true boolean constant
  - FALSE
```
public static final com.intellij.codeInspection.dataFlow.types.DfBooleanConstantType FALSE
```
    A false boolean constant
  - INT
```
public static final DfIntType INT
```
    A type that corresponds to JVM int type
  - LONG
```
public static final DfLongType LONG
```
    A type that corresponds to JVM long type
  - FLOAT
```
public static final DfFloatType FLOAT
```
    A type that corresponds to JVM float type
  - DOUBLE
```
public static final DfDoubleType DOUBLE
```
    A type that corresponds to JVM double type
  - NULL
```
public static final DfNullConstantType NULL
```
    A reference type that contains only null reference
  - NOT_NULL_OBJECT
```
public static final DfReferenceType NOT_NULL_OBJECT
```
    A reference type that contains any reference except null
  - OBJECT_OR_NULL
```
public static final DfReferenceType OBJECT_OR_NULL
```
    A reference type that contains any reference or null
  - LOCAL_OBJECT
```
public static final DfReferenceType LOCAL_OBJECT
```
    A reference type that contains any reference to a local object
- Method Detail
  - booleanValue
```
public static com.intellij.codeInspection.dataFlow.types.DfBooleanConstantType booleanValue(boolean value)
```
    Parameters:
    
    value - boolean value
    
    Returns:
    
    a boolean constant having given value
  - intRangeClamped
```
public static DfType intRangeClamped(LongRangeSet range)
```
    Creates a type that represents a subset of int values, clamping values not representable in the JVM int type.
    
    Parameters:
    
    range - range of values. Values that cannot be represented in JVM int type are removed from this range upon creation.
    
    Returns:
    
    resulting type. Might be BOTTOM if range is empty or all its values are out of the int domain.
  - intRange
```
public static DfType intRange(LongRangeSet range)
```
    Creates a type that represents a subset of int values.
    
    Parameters:
    
    range - range of values.
    
    Returns:
    
    resulting type. Might be BOTTOM if range is empty.
    
    Throws:
    
    java.lang.IllegalArgumentException - if range contains values not representable in the JVM int type.
  - intValue
```
public static com.intellij.codeInspection.dataFlow.types.DfIntConstantType intValue(int value)
```
    Parameters:
    
    value - int value
    
    Returns:
    
    a int constant type that contains a given value
  - longRange
```
public static DfType longRange(LongRangeSet range)
```
    Creates a type that represents a subset of long values.
    
    Parameters:
    
    range - range of values.
    
    Returns:
    
    resulting type. Might be BOTTOM if range is empty.
  - longValue
```
public static com.intellij.codeInspection.dataFlow.types.DfLongConstantType longValue(long value)
```
    Parameters:
    
    value - long value
    
    Returns:
    
    a long constant type that contains a given value
  - rangeClamped
```
public static DfType rangeClamped(LongRangeSet range,
                                  boolean isLong)
```
    A convenience selector method to call longRange(LongRangeSet) or intRangeClamped(LongRangeSet)
    
    Parameters:
    
    range - range
    
    isLong - whether int or long type should be created
    
    Returns:
    
    resulting type.
  - floatValue
```
public static com.intellij.codeInspection.dataFlow.types.DfFloatConstantType floatValue(float value)
```
    Parameters:
    
    value - float value
    
    Returns:
    
    a float constant type that contains a given value
  - doubleValue
```
public static com.intellij.codeInspection.dataFlow.types.DfDoubleConstantType doubleValue(double value)
```
    Parameters:
    
    value - double value
    
    Returns:
    
    a double constant type that contains a given value
  - constant
```
public static DfConstantType<?> constant(java.lang.Object constant,
                                         PsiType type)
```
    Returns a custom constant type
    
    Parameters:
    
    constant - constant value
    
    type - value type
    
    Returns:
    
    a constant type that contains only given constant
  - defaultValue
```
public static DfConstantType<?> defaultValue(PsiType type)
```
    Parameters:
    
    type - PsiType to get default value of
    
    Returns:
    
    a constant that represents a JVM default value of given type (0 for int, false for boolean, etc)
  - typedObject
```
public static DfType typedObject(PsiType type,
                                 Nullability nullability)
```
    Parameters:
    
    type - type of the object
    
    nullability - nullability
    
    Returns:
    
    a type that references given objects of given type (or it subtypes) and has given nullability
  - customObject
```
public static DfReferenceType customObject(TypeConstraint constraint,
                                           DfaNullability nullability,
                                           Mutability mutability,
                                           SpecialField specialField,
                                           DfType sfType)
```
    A low-level method to construct a custom reference type. Should not be normally used. Instead prefer construct a type using a series of DfType.meet(DfType) calls like
```
 constraint.asDfType()
   .meet(mutability.asDfType())
   .meet(LOCAL_OBJECT)
   .meet(specialField.asDfType(sfType))
 
```
    Parameters:
    
    constraint - type constraint
    
    nullability - nullability, must not be DfaNullability.NULL
    
    mutability - mutability desired mutability
    
    specialField - special field
    
    sfType - type of special field
    
    Returns:
    
    a reference type object

Class DfTypes

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TOP

BOTTOM

FAIL

BOOLEAN

TRUE

FALSE

INT

LONG

FLOAT

DOUBLE

NULL

NOT_NULL_OBJECT

OBJECT_OR_NULL

LOCAL_OBJECT

Method Detail

booleanValue

intRangeClamped

intRange

intValue

longRange

longValue

rangeClamped

floatValue

doubleValue

constant

defaultValue

typedObject

customObject