org.checkerframework.javacutil

Class TypeKindUtils

java.lang.Object

org.checkerframework.javacutil.TypeKindUtils

public final class TypeKindUtils
extends Object

A utility class that helps with TypeKinds.

Method Summary

Modifier and Type	Method and Description
static boolean	isFloatingPoint(TypeKind typeKind) Return true if the argument is one of FLOAT, DOUBLE.
static boolean	isIntegral(TypeKind typeKind) Return true if the argument is one of INT, SHORT, BYTE, CHAR, LONG.
static boolean	isNarrower(TypeKind a, TypeKind b) Returns true if a widening conversion happens between the types.
static boolean	isNumeric(TypeKind typeKind) Returns true iff the argument is a primitive numeric type kind.
static @Nullable TypeKind	primitiveOrBoxedToTypeKind(TypeMirror type) Given a primitive type, return its kind.
static TypeKind	widenedNumericType(TypeKind a, TypeKind b) Given two type kinds, return the type kind they are widened to, when an arithmetic operation is performed on them.
static TypeKind	widenedNumericType(TypeMirror left, TypeMirror right) Returns the widened numeric type for an arithmetic operation performed on a value of the left type and the right type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isIntegral

public static boolean isIntegral(TypeKind typeKind)

Return true if the argument is one of INT, SHORT, BYTE, CHAR, LONG.

Parameters:

typeKind - the TypeKind to inspect

Returns:

true if typeKind is a primitive integral type kind

isFloatingPoint

public static boolean isFloatingPoint(TypeKind typeKind)

Return true if the argument is one of FLOAT, DOUBLE.

Parameters:

typeKind - the TypeKind to inspect

Returns:

true if typeKind is a primitive floating point type kind

isNumeric

public static boolean isNumeric(TypeKind typeKind)

Returns true iff the argument is a primitive numeric type kind.

Parameters:

typeKind - a type kind

Returns:

true if the argument is a primitive numeric type kind

primitiveOrBoxedToTypeKind

public static @Nullable TypeKind primitiveOrBoxedToTypeKind(TypeMirror type)

Given a primitive type, return its kind. Given a boxed primitive type, return the corresponding primitive type kind. Otherwise, return null.

Parameters:

type - a primitive or boxed primitive type

Returns:

a primitive type kind, or null

widenedNumericType

public static TypeKind widenedNumericType(TypeMirror left,
                                          TypeMirror right)

Returns the widened numeric type for an arithmetic operation performed on a value of the left type and the right type. Defined in JLS 5.6.2. We return a TypeKind because creating a TypeMirror requires a Types object from the ProcessingEnvironment.

Parameters:

left - a type mirror

right - a type mirror

Returns:

the result of widening numeric conversion, or NONE when the conversion cannot be performed

widenedNumericType

public static TypeKind widenedNumericType(TypeKind a,
                                          TypeKind b)

Given two type kinds, return the type kind they are widened to, when an arithmetic operation is performed on them. Defined in JLS 5.6.2.

Parameters:

a - a type kind

b - a type kind

Returns:

the type kind to which they are widened, when an operation is performed on them

isNarrower

public static boolean isNarrower(TypeKind a,
                                 TypeKind b)

Returns true if a widening conversion happens between the types. This is true if

• the first type is is integral and the second type is floating-point, or
• both types are integral or both types are floating-point, and the first type is strictly narrower (represented by fewer bits) than the second type.

Parameters:

a - a primitive type

b - a primitive type

Returns:

true if a is represented by fewer bits than b