Interface UType

@Generated("avaje-prism-generator")
public interface UType

Utility type to help process TypeMirrors

Method Summary

Modifier and Type	Method	Description
default List<AnnotationMirror>	allAnnotationsInType()	Return the annotation mirrors directly on the type and in within generic type use.
default List<AnnotationMirror>	annotations()	Return the annotation mirrors directly on the type.
default List<UType>	componentTypes()	Retrieve the component types associated with this mirror.
boolean	equals(Object other)	Compare whether the current full() type is identical to the given UType's full() type
String	full()	Return the full type as a code safe string.
default String	fullWithoutAnnotations()	Return the full type as a string, stripped of annotations.
Set<String>	importTypes()	Return all the import types needed to write this mirror in source code (annotations included).
default boolean	isGeneric()	Returns whether the type mirror is generic
TypeKind	kind()	The TypeKind of the type mirror used to create this Utype.
String	mainType()	Return the main type (outermost type). e.g for mirror invalid input: '{@' java.util.List you'll get java.util.List
default UType	param0()	Return the first generic parameter.
default UType	param1()	Return the second componentType.
static UType	parse(TypeMirror mirror)	Create a UType from the given TypeMirror.
String	shortType()	Return the full (but unqualified) type as a code safe string.
default String	shortWithoutAnnotations()	Return the short type as a string, stripped of annotations.

Method Details

parse

static UType parse(TypeMirror mirror)

Create a UType from the given TypeMirror.

Parameters:

mirror - type mirror to analyze

Returns:

Create the UType from the given TypeMirror.

importTypes

Set<String> importTypes()

Return all the import types needed to write this mirror in source code (annotations included).

Returns:

Return the import types required.

full

String full()

Return the full type as a code safe string. (with annotations if present)

Returns:

the full typeName

mainType

String mainType()

Return the main type (outermost type). e.g for mirror invalid input: '{@' java.util.List you'll get java.util.List

Returns:

the outermost type

shortType

String shortType()

Return the full (but unqualified) type as a code safe string. Use in tandem with importTypes() to generate readable code

Returns:

the short name with unqualified type

param0

default UType param0()

Return the first generic parameter.

See Also:

• componentTypes()

param1

default UType param1()

Return the second componentType.

See Also:

• componentTypes()

componentTypes

default List<UType> componentTypes()

Retrieve the component types associated with this mirror.

• TypeKind.ARRAY: will contain the array componentType
• TypeKind.DECLARED: will contain the generic parameters
• TypeKind.TYPEVAR: will contain the upper bound for the type variable
• TypeKind.WILDCARD: will contain the extends bound or super bound
• TypeKind.INTERSECTION: will contain the bounds of the intersection
• TypeKind.UNION: will contain the alternative types

Returns:

the component types

kind

TypeKind kind()

The TypeKind of the type mirror used to create this Utype.

isGeneric

default boolean isGeneric()

Returns whether the type mirror is generic

Returns:

whether the type is generic

annotations

default List<AnnotationMirror> annotations()

Return the annotation mirrors directly on the type.

For a UType representing @NotEmpty Map<@Notblank String, Object> you will get mirrors for @NotEmpty only

Returns:

the annotations directly present

allAnnotationsInType

default List<AnnotationMirror> allAnnotationsInType()

Return the annotation mirrors directly on the type and in within generic type use.

For a UType representing @NotEmpty Map<@Notblank String, Object> you will get mirrors for @NotEmpty and @Notblank

Returns:

all annotations present on this type

fullWithoutAnnotations

default String fullWithoutAnnotations()

Return the full type as a string, stripped of annotations.

Returns:

full type, but without annotations

shortWithoutAnnotations

default String shortWithoutAnnotations()

Return the short type as a string, stripped of annotations.

Returns:

short type, but without annotations

equals

boolean equals(Object other)

Compare whether the current full() type is identical to the given UType's full() type

Overrides:

equals in class Object