ch.jalu.typeresolver.primitives

Enum PrimitiveType

java.lang.Object

java.lang.Enum<PrimitiveType>

ch.jalu.typeresolver.primitives.PrimitiveType

All Implemented Interfaces:

Serializable, Comparable<PrimitiveType>

public enum PrimitiveType
extends Enum<PrimitiveType>

Defines primitive-reference class pairs and holds other utilities relating to primitive types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOOLEAN Boolean type pair.
BYTE Byte type pair.
CHARACTER Character type pair.
DOUBLE Double type pair.
FLOAT Float type pair.
INTEGER Integer type pair.
LONG Long type pair.
SHORT Short type pair.

Method Summary

Modifier and Type	Method and Description
static @Nullable PrimitiveType	from(Class<?> clazz) Returns the PrimitiveType entry that corresponds to the given class, or null if not available.
Object	getDefaultValue()
Class<?>	getPrimitiveType()
Class<?>	getReferenceType()
static boolean	isRealPrimitive(@Nullable Class<?> clazz) Returns whether the class is a primitive type.
boolean	matches(@Nullable Class<?> clazz) Returns whether the given class matches this primitive-reference class pair.
static Class<?>	toPrimitiveType(Class<?> clazz) Returns the given class's primitive class equivalent, if applicable.
static Class<?>	toReferenceType(Class<?> clazz) Returns the given class's reference class equivalent, if applicable.
static PrimitiveType	valueOf(String name) Returns the enum constant of this type with the specified name.
static PrimitiveType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BOOLEAN

public static final PrimitiveType BOOLEAN

Boolean type pair.

BYTE

public static final PrimitiveType BYTE

Byte type pair.

CHARACTER

public static final PrimitiveType CHARACTER

Character type pair.

SHORT

public static final PrimitiveType SHORT

Short type pair.

INTEGER

public static final PrimitiveType INTEGER

Integer type pair.

LONG

public static final PrimitiveType LONG

Long type pair.

FLOAT

public static final PrimitiveType FLOAT

Float type pair.

DOUBLE

public static final PrimitiveType DOUBLE

Double type pair.

Method Detail

values

public static PrimitiveType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PrimitiveType c : PrimitiveType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PrimitiveType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getPrimitiveType

public Class<?> getPrimitiveType()

getReferenceType

public Class<?> getReferenceType()

getDefaultValue

public Object getDefaultValue()

Returns:

default value of the primitive type (e.g. for an uninitialized field); never null

matches

public boolean matches(@Nullable
                       @Nullable Class<?> clazz)

Returns whether the given class matches this primitive-reference class pair.

Parameters:

clazz - the class to process

Returns:

true if this entry is associated with the given class, false otherwise

from

@Nullable
public static @Nullable PrimitiveType from(Class<?> clazz)

Returns the PrimitiveType entry that corresponds to the given class, or null if not available.

Parameters:

clazz - the class to search for (primitive or reference type of a primitive-reference class pair)

Returns:

the corresponding entry, or null if not applicable

toPrimitiveType

public static Class<?> toPrimitiveType(Class<?> clazz)

Returns the given class's primitive class equivalent, if applicable. Returns the argument if not applicable.

Note that Void is not converted to void.class.

Parameters:

clazz - the class to process

Returns:

the class's primitive type equivalent, or the provided argument if not applicable

toReferenceType

public static Class<?> toReferenceType(Class<?> clazz)

Returns the given class's reference class equivalent, if applicable. Returns the argument if not applicable.

Note that void.class is not converted to Void.

Parameters:

clazz - the class to process

Returns:

the class's reference type equivalent, or the provided argument if not applicable

isRealPrimitive

public static boolean isRealPrimitive(@Nullable
                                      @Nullable Class<?> clazz)

Returns whether the class is a primitive type. Unlike Class.isPrimitive(), false is returned for void.class.

Parameters:

clazz - the class to process

Returns:

true if the class is primitive, false otherwise