top.wavelength.betterreflection.dumper

Enum TypeDisplayNameFormat

java.lang.Object

java.lang.Enum<TypeDisplayNameFormat>

top.wavelength.betterreflection.dumper.TypeDisplayNameFormat

All Implemented Interfaces:

Serializable, Comparable<TypeDisplayNameFormat>

public enum TypeDisplayNameFormat
extends Enum<TypeDisplayNameFormat>

TypeDisplayNameFormat is an enumeration that represents different formats for displaying the names of types. It provides methods to get the formatted names of classes, methods, fields, and parameters.

Since:

1.2

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANONICAL_NAME
FULL_NAME
NONE
SIMPLE_NAME
TYPE_NAME

Method Summary

Modifier and Type	Method and Description
String	getName(Class<?> type) Returns the name of the given type based on the specified TypeDisplayNameFormat.
String	getName(Field field) Returns the name of the given field's type.
String	getName(Method method) Returns the name of the given method's return type based on the specified TypeDisplayNameFormat.
String	getName(Parameter parameter) Returns the name of the given parameter's type based on the specified TypeDisplayNameFormat.
static TypeDisplayNameFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static TypeDisplayNameFormat[]	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

FULL_NAME

public static final TypeDisplayNameFormat FULL_NAME

CANONICAL_NAME

public static final TypeDisplayNameFormat CANONICAL_NAME

TYPE_NAME

public static final TypeDisplayNameFormat TYPE_NAME

SIMPLE_NAME

public static final TypeDisplayNameFormat SIMPLE_NAME

NONE

public static final TypeDisplayNameFormat NONE

Method Detail

values

public static TypeDisplayNameFormat[] 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 (TypeDisplayNameFormat c : TypeDisplayNameFormat.values())
    System.out.println(c);

Returns:

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

valueOf

public static TypeDisplayNameFormat 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

getName

public String getName(Class<?> type)

Returns the name of the given type based on the specified TypeDisplayNameFormat.

Parameters:

type - The type for which the name will be returned

Returns:

The formatted name of the type

Since:

1.2

getName

public String getName(Method method)

Returns the name of the given method's return type based on the specified TypeDisplayNameFormat.

Parameters:

method - The Method object for which the return type name will be returned

Returns:

The formatted name of the return type of the method

Since:

1.2

getName

public String getName(Field field)

Returns the name of the given field's type.

Parameters:

field - The field for which the type name will be returned

Returns:

The name of the field's type

Since:

1.2

getName

public String getName(Parameter parameter)

Returns the name of the given parameter's type based on the specified TypeDisplayNameFormat.

Parameters:

parameter - The parameter for which the type name will be returned

Returns:

The formatted name of the parameter's type

Since:

1.2