io.micronaut.core.type

Interface ReturnType<T>

Type Parameters:

T - The concrete type

All Superinterfaces:

AnnotationMetadataProvider, AnnotationSource, TypeVariableResolver

public interface ReturnType<T>
extends TypeVariableResolver, AnnotationMetadataProvider

Models a return type of an Executable method in Micronaut.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields inherited from interface io.micronaut.core.annotation.AnnotationSource

EMPTY

Method Summary

Modifier and Type	Method and Description
default Argument<T>	asArgument()
java.lang.Class<T>	getType()
default boolean	isAsync()
default boolean	isAsyncOrReactive()
default boolean	isCompletable()
default boolean	isOptional()
default boolean	isReactive()
default boolean	isSingleResult()
default boolean	isSpecifiedSingle()
default boolean	isSuspended()
default boolean	isVoid() Returns whether the return type is logically void.
static <T1> ReturnType<T1>	of(java.lang.Class<T1> type, Argument<?>... typeArguments) Create a new return type from the given type and arguments.

Methods inherited from interface io.micronaut.core.type.TypeVariableResolver

getFirstTypeVariable, getTypeParameters, getTypeVariable, getTypeVariables

Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadataProvider

findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, getAnnotationMetadata, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

Methods inherited from interface io.micronaut.core.annotation.AnnotationSource

getAnnotation, getAnnotation, getDeclaredAnnotation, getDeclaredAnnotation

Method Detail

getType

@NonNull
java.lang.Class<T> getType()

Returns:

The type of the argument

asArgument

@NonNull
default Argument<T> asArgument()

Returns:

The return type as an argument

isSuspended

default boolean isSuspended()

Returns:

Is the return type suspended function (Kotlin).

Since:

2.0.0

isReactive

default boolean isReactive()

Returns:

Is the return type reactive.

Since:

2.0.0

isCompletable

default boolean isCompletable()

Returns:

Is the return the return type a reactive completable type.

Since:

2.0.0

isSingleResult

default boolean isSingleResult()

Returns:

Is the return type a single result or multiple results

Since:

2.0

isSpecifiedSingle

default boolean isSpecifiedSingle()

Returns:

Has the return type been specified to emit a single result with SingleResult.

Since:

2.0

isAsync

default boolean isAsync()

Returns:

Is the return type asynchronous.

Since:

2.0.0

isAsyncOrReactive

default boolean isAsyncOrReactive()

Returns:

Is the return type either async or reactive.

Since:

2.0.0

isVoid

default boolean isVoid()

Returns whether the return type is logically void. This includes reactive times that emit nothing (such as Completable) and asynchronous types that emit Void.

Returns:

Is the return type logically void.

Since:

2.0.0

isOptional

default boolean isOptional()

Returns:

Is the return type Optional.

Since:

2.0.1

of

static <T1> ReturnType<T1> of(java.lang.Class<T1> type,
                              Argument<?>... typeArguments)

Create a new return type from the given type and arguments.

Type Parameters:

T1 - The return type

Parameters:

type - The type

typeArguments - The type arguments

Returns:

A ReturnType