ch.jalu.typeresolver.array

Class ArrayTypeUtils

java.lang.Object

ch.jalu.typeresolver.array.ArrayTypeUtils

public final class ArrayTypeUtils
extends Object

Utilities for array types.

Method Summary

Modifier and Type	Method and Description
static Class<?>	createArrayClass(Class<?> componentType) Returns an array class of the given component type, e.g.
static Class<?>	createArrayClass(Class<?> componentType, int dimension) Returns an array class of the given component type and with the given dimensions, e.g.
static Type	createArrayType(Type componentType) Returns an array class or a GenericArrayType instance whose component type is the componentType argument.
static Type	createArrayType(Type componentType, int dimension) Returns an array class or a generic array type whose component is the provided component type and with the given dimension.
static ArrayTypeProperties	getArrayProperty(Type type) Returns a description of the given array type, or an array property with dimension 0 if it is not an array.

Methods inherited from class java.lang.Object

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

Method Detail

createArrayClass

public static Class<?> createArrayClass(Class<?> componentType)

Returns an array class of the given component type, e.g. if the componentType is String.class, then String[].class is returned.

As of Java 12, you can use componentType.arrayType().

Parameters:

componentType - the component type of the array

Returns:

array class of the given component

Throws:

IllegalArgumentException - if the component type is void.class

createArrayClass

public static Class<?> createArrayClass(Class<?> componentType,
                                        int dimension)

Returns an array class of the given component type and with the given dimensions, e.g. if the componentType is double.class and the dimension is 3, then double[][][].class is returned.

Parameters:

componentType - the component type of the array

dimension - the dimension of the class (may not be negative)

Returns:

array class of the provided dimension with the given component

Throws:

IllegalArgumentException - if the dimension is negative, or if the component type is void.class

createArrayType

public static Type createArrayType(Type componentType)

Returns an array class or a GenericArrayType instance whose component type is the componentType argument.

This method does not validate the component type, making it possible to create generic array types that might not make sense or that may never be provided by the JDK. The JDK specifies that the component of a generic array type is either a parameterized type or a type variable.

Parameters:

componentType - the component type to create an array type for

Returns:

the appropriate array type

Throws:

IllegalArgumentException - if the dimension is negative, or if the component type is void.class

createArrayType

public static Type createArrayType(Type componentType,
                                   int dimension)

Returns an array class or a generic array type whose component is the provided component type and with the given dimension.

This method does not validate the component type, making it possible to create generic array types that might not make sense or that may never be provided by the JDK. The JDK specifies that the component of a generic array type is either a parameterized type or a type variable.

Parameters:

componentType - the component type

dimension - the dimension of the array (may not be negative)

Returns:

the appropriate array type of the given dimension

Throws:

IllegalArgumentException - if the dimension is negative, or if the component type is void.class

getArrayProperty

public static ArrayTypeProperties getArrayProperty(Type type)

Returns a description of the given array type, or an array property with dimension 0 if it is not an array. Never returns null.

Parameters:

type - the type to inspect

Returns:

array description of the given type, never null