Package io.micronaut.core.type

Enum Class TypeInformation.TypeFormat

java.lang.Object

java.lang.Enum<TypeInformation.TypeFormat>

io.micronaut.core.type.TypeInformation.TypeFormat

All Implemented Interfaces:

Serializable, Comparable<TypeInformation.TypeFormat>, Constable

Enclosing interface:

TypeInformation<T>

public static enum TypeInformation.TypeFormat
extends Enum<TypeInformation.TypeFormat>

Type formatting to apply.

Since:

4.8.0

See Also:

• TypeInformation.getTypeString(boolean)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANSI_QUALIFIED	Qualified name highlighted with ANSI.
ANSI_SHORTENED	Shortened name highlighted with ANSI.
ANSI_SIMPLE	Simple name highlighted wit ANSI.
QUALIFIED	Qualified format.
SHORTENED	Shorted format.
SIMPLE	Simple format.

Method Summary

Modifier and Type	Method	Description
String	formatAnnotation(String annotationRef)	Format the annotation name.
static @NonNull String	getBeanTypeString(@NonNull TypeInformation.TypeFormat format, @NonNull Class<?> type, @NonNull Map<String,Argument<?>> generics, @NonNull AnnotationMetadata annotationMetadata)	Get a type string for the given format.
static @NonNull String	getBeanTypeString(TypeInformation.TypeFormat typeFormat, @NonNull Argument<?> argument)	Obtain the bean type string.
static @NonNull String	getTypeString(@NonNull TypeInformation.TypeFormat format, @NonNull Class<?> type, @NonNull Map<String,Argument<?>> generics)	Get a type string for the given format.
boolean	isAnsi()
static TypeInformation.TypeFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TypeInformation.TypeFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SIMPLE

public static final TypeInformation.TypeFormat SIMPLE

Simple format.

QUALIFIED

public static final TypeInformation.TypeFormat QUALIFIED

Qualified format.

SHORTENED

public static final TypeInformation.TypeFormat SHORTENED

Shorted format.

ANSI_SIMPLE

public static final TypeInformation.TypeFormat ANSI_SIMPLE

Simple name highlighted wit ANSI.

ANSI_QUALIFIED

public static final TypeInformation.TypeFormat ANSI_QUALIFIED

Qualified name highlighted with ANSI.

ANSI_SHORTENED

public static final TypeInformation.TypeFormat ANSI_SHORTENED

Shortened name highlighted with ANSI.

Method Details

values

public static TypeInformation.TypeFormat[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static TypeInformation.TypeFormat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getBeanTypeString

@NonNull
public static @NonNull String getBeanTypeString(@NonNull
 TypeInformation.TypeFormat typeFormat,
 @NonNull
 @NonNull Argument<?> argument)

Obtain the bean type string.

Parameters:

typeFormat - The type format

argument - The argument

Returns:

The string

isAnsi

public boolean isAnsi()

Returns:

Is an ANSI format.

formatAnnotation

public String formatAnnotation(String annotationRef)

Format the annotation name.

Parameters:

annotationRef - The type name

Returns:

The annotation

getTypeString

@NonNull
public static @NonNull String getTypeString(@NonNull
 @NonNull TypeInformation.TypeFormat format,
 @NonNull
 @NonNull Class<?> type,
 @NonNull
 @NonNull Map<String,Argument<?>> generics)

Get a type string for the given format.

Parameters:

format - The format

type - The type

generics - The generics

Returns:

the type string

getBeanTypeString

@NonNull
public static @NonNull String getBeanTypeString(@NonNull
 @NonNull TypeInformation.TypeFormat format,
 @NonNull
 @NonNull Class<?> type,
 @NonNull
 @NonNull Map<String,Argument<?>> generics,
 @NonNull
 @NonNull AnnotationMetadata annotationMetadata)

Get a type string for the given format.

Parameters:

format - The format

type - The type

generics - The generics

annotationMetadata - The annotation metadata

Returns:

the type string