io.micronaut.core.type

Interface Argument<T>

Type Parameters:

T - The argument type

All Superinterfaces:

AnnotatedElement, AnnotationMetadataProvider, AnnotationSource, Named, java.lang.reflect.Type, TypeVariableResolver

All Known Subinterfaces:

ArgumentValue<V>, MutableArgumentValue<V>

All Known Implementing Classes:

ArgumentBeanType, DefaultArgument, GenericArgument

public interface Argument<T>
extends TypeVariableResolver, AnnotatedElement, java.lang.reflect.Type

Represents an argument to a method or constructor or type.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
static Argument<java.lang.Boolean>	BOOLEAN Constant for boolean argument.
static Argument<java.lang.Byte>	BYTE Constant for byte argument.
static Argument<java.lang.Character>	CHAR Constant char argument.
static Argument<java.lang.Double>	DOUBLE Constant for double argument.
static Argument<java.lang.Float>	FLOAT Constant for float argument.
static Argument<java.lang.Integer>	INT Constant for int argument.
static Argument<java.util.List<java.lang.String>>	LIST_OF_STRING Constant for List argument.
static Argument<java.lang.Long>	LONG Constant for long argument.
static Argument<java.lang.Object>	OBJECT_ARGUMENT Default Object argument.
static Argument<java.lang.Short>	SHORT Constant short argument.
static Argument<java.lang.String>	STRING Constant for string argument.
static Argument<java.lang.Void>	VOID Constant for void argument.
static Argument[]	ZERO_ARGUMENTS Constant representing zero arguments.

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

EMPTY

Method Summary

Modifier and Type	Method and Description
default java.lang.reflect.ParameterizedType	asParameterizedType() Represent this argument as a ParameterizedType.
boolean	equalsType(Argument<?> other) Whether the types are equivalent.
java.lang.String	getName()
java.lang.Class<T>	getType()
default java.lang.String	getTypeName()
default java.lang.String	getTypeString(boolean simple) Returns the string representation of the argument type, including generics.
default boolean	hasTypeVariables()
default boolean	isAsync()
default boolean	isAsyncOrReactive()
default boolean	isCompletable()
default boolean	isContainerType()
default boolean	isInstance(java.lang.Object o) Whether the given argument is an instance.
default boolean	isOptional()
default boolean	isReactive()
default boolean	isVoid() Returns whether the return type is logically void.
static <T> Argument<java.util.List<T>>	listOf(Argument<T> type) Creates a new argument representing a generic list.
static <T> Argument<java.util.List<T>>	listOf(java.lang.Class<T> type) Creates a new argument representing a generic list.
static <K,V> Argument<java.util.Map<K,V>>	mapOf(Argument<K> keyType, Argument<V> valueType) Creates a new argument representing a generic map.
static <K,V> Argument<java.util.Map<K,V>>	mapOf(java.lang.Class<K> keyType, java.lang.Class<V> valueType) Creates a new argument representing a generic map.
static <T> Argument<T>	of(java.lang.Class<T> type) Creates a new argument for the given type and name.
static <T> Argument<T>	of(java.lang.Class<T> type, AnnotationMetadata annotationMetadata, Argument... typeParameters) Creates a new argument for the given type and name.
static <T> Argument<T>	of(java.lang.Class<T> type, Argument... typeParameters) Creates a new argument for the given type and name.
static <T> Argument<T>	of(java.lang.Class<T> type, java.lang.Class<?>... typeParameters) Creates a new argument for the given type and name.
static <T> Argument<T>	of(java.lang.Class<T> type, java.lang.String name) Creates a new argument for the given type and name.
static <T> Argument<T>	of(java.lang.Class<T> type, java.lang.String name, AnnotationMetadata annotationMetadata, Argument... typeParameters) Creates a new argument for the given type and name.
static <T> Argument<T>	of(java.lang.Class<T> type, java.lang.String name, Argument... typeParameters) Creates a new argument for the given type and name.
static <T> Argument<java.util.Set<T>>	setOf(Argument<T> type) Creates a new argument representing a generic set.
static <T> Argument<java.util.Set<T>>	setOf(java.lang.Class<T> type) Creates a new argument representing a generic set.
static java.lang.Class[]	toClassArray(Argument... arguments) Convert an argument array to a class array.
static java.lang.String	toString(Argument... arguments) Convert the arguments to a string representation.
int	typeHashCode() The hash code including only the types.

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

getFirstTypeVariable, getTypeParameters, getTypeVariable, getTypeVariables

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

isDeclaredNonNull, isDeclaredNullable, isNonNull, isNullable

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

Field Detail

STRING

static final Argument<java.lang.String> STRING

Constant for string argument.

INT

static final Argument<java.lang.Integer> INT

Constant for int argument. Used by generated code, do not remove.

LONG

static final Argument<java.lang.Long> LONG

Constant for long argument. Used by generated code, do not remove.

FLOAT

static final Argument<java.lang.Float> FLOAT

Constant for float argument. Used by generated code, do not remove.

DOUBLE

static final Argument<java.lang.Double> DOUBLE

Constant for double argument. Used by generated code, do not remove.

VOID

static final Argument<java.lang.Void> VOID

Constant for void argument. Used by generated code, do not remove.

BYTE

static final Argument<java.lang.Byte> BYTE

Constant for byte argument. Used by generated code, do not remove.

BOOLEAN

static final Argument<java.lang.Boolean> BOOLEAN

Constant for boolean argument. Used by generated code, do not remove.

CHAR

static final Argument<java.lang.Character> CHAR

Constant char argument. Used by generated code, do not remove.

SHORT

static final Argument<java.lang.Short> SHORT

Constant short argument. Used by generated code, do not remove.

ZERO_ARGUMENTS

static final Argument[] ZERO_ARGUMENTS

Constant representing zero arguments. Used by generated code, do not remove.

OBJECT_ARGUMENT

static final Argument<java.lang.Object> OBJECT_ARGUMENT

Default Object argument. Used by generated code, do not remove.

LIST_OF_STRING

static final Argument<java.util.List<java.lang.String>> LIST_OF_STRING

Constant for List argument.

Method Detail

getName

@NonNull
java.lang.String getName()

Specified by:

getName in interface Named

Returns:

The name of the argument

getTypeName

@NonNull
default java.lang.String getTypeName()

Specified by:

getTypeName in interface java.lang.reflect.Type

getType

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

Returns:

The type of the argument

equalsType

boolean equalsType(Argument<?> other)

Whether the types are equivalent. The regular Object.equals(Object) implementation includes the argument name within the comparison so this method offers a variation that just compares types.

Parameters:

other - The type type

Returns:

True if they are equal

typeHashCode

int typeHashCode()

The hash code including only the types. The regular Object.hashCode() implementation includes the argument name within the comparison so this method offers a variation that just compares types.

Returns:

The type hash code

asParameterizedType

@NonNull
default java.lang.reflect.ParameterizedType asParameterizedType()

Represent this argument as a ParameterizedType.

Returns:

The ParameterizedType

Since:

2.0.0

isInstance

default boolean isInstance(@Nullable
                           java.lang.Object o)

Whether the given argument is an instance.

Parameters:

o - The object

Returns:

True if it is an instance of this type

getTypeString

default java.lang.String getTypeString(boolean simple)

Returns the string representation of the argument type, including generics.

Parameters:

simple - If true, output the simple name of types

Returns:

The type string representation

hasTypeVariables

default boolean hasTypeVariables()

Returns:

Whether the argument has any type variables

isContainerType

default boolean isContainerType()

Returns:

Whether this is a container type.

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

isAsync

default boolean isAsync()

Returns:

Is the return type asynchronous.

Since:

2.0.0

isOptional

default boolean isOptional()

Returns:

Is this type an optional

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

toClassArray

@NonNull
static java.lang.Class[] toClassArray(Argument... arguments)

Convert an argument array to a class array.

Parameters:

arguments - The arguments

Returns:

The class array

toString

@NonNull
static java.lang.String toString(Argument... arguments)

Convert the arguments to a string representation.

Parameters:

arguments - The arguments

Returns:

The String representation

of

@NonNull
static <T> Argument<T> of(java.lang.Class<T> type,
                                   java.lang.String name,
                                   @Nullable
                                   Argument... typeParameters)

Creates a new argument for the given type and name.

Type Parameters:

T - The generic type

Parameters:

type - The type

name - The name

typeParameters - the type parameters

Returns:

The argument instance

of

@NonNull
static <T> Argument<T> of(java.lang.Class<T> type,
                                   java.lang.String name,
                                   AnnotationMetadata annotationMetadata,
                                   @Nullable
                                   Argument... typeParameters)

Creates a new argument for the given type and name.

Type Parameters:

T - The generic type

Parameters:

type - The type

name - The name

annotationMetadata - the annotation metadata

typeParameters - the type parameters

Returns:

The argument instance

of

@NonNull
static <T> Argument<T> of(java.lang.Class<T> type,
                                   AnnotationMetadata annotationMetadata,
                                   @Nullable
                                   Argument... typeParameters)

Creates a new argument for the given type and name.

Type Parameters:

T - The generic type

Parameters:

type - The type

annotationMetadata - the annotation metadata

typeParameters - the type parameters

Returns:

The argument instance

of

@NonNull
static <T> Argument<T> of(java.lang.Class<T> type,
                                   java.lang.String name)

Creates a new argument for the given type and name.

Type Parameters:

T - The generic type

Parameters:

type - The type

name - The name

Returns:

The argument instance

of

@NonNull
static <T> Argument<T> of(java.lang.Class<T> type,
                                   @Nullable
                                   Argument... typeParameters)

Creates a new argument for the given type and name.

Type Parameters:

T - The generic type

Parameters:

type - The type

typeParameters - The parameters type

Returns:

The argument instance

of

@NonNull
static <T> Argument<T> of(java.lang.Class<T> type)

Creates a new argument for the given type and name.

Type Parameters:

T - The generic type

Parameters:

type - The type

Returns:

The argument instance

of

@NonNull
static <T> Argument<T> of(java.lang.Class<T> type,
                                   @Nullable
                                   java.lang.Class<?>... typeParameters)

Creates a new argument for the given type and name.

Type Parameters:

T - The generic type

Parameters:

type - The type

typeParameters - the parameters type

Returns:

The argument instance

listOf

@NonNull
static <T> Argument<java.util.List<T>> listOf(java.lang.Class<T> type)

Creates a new argument representing a generic list.

Type Parameters:

T - list element type

Parameters:

type - list element type

Returns:

The argument instance

listOf

@NonNull
static <T> Argument<java.util.List<T>> listOf(Argument<T> type)

Creates a new argument representing a generic list.

Type Parameters:

T - list element type

Parameters:

type - list element type

Returns:

The argument instance

Since:

2.0.1

setOf

@NonNull
static <T> Argument<java.util.Set<T>> setOf(java.lang.Class<T> type)

Creates a new argument representing a generic set.

Type Parameters:

T - set element type

Parameters:

type - set element type

Returns:

The argument instance

setOf

@NonNull
static <T> Argument<java.util.Set<T>> setOf(Argument<T> type)

Creates a new argument representing a generic set.

Type Parameters:

T - set element type

Parameters:

type - set element type

Returns:

The argument instance

Since:

2.0.1

mapOf

@NonNull
static <K,V> Argument<java.util.Map<K,V>> mapOf(java.lang.Class<K> keyType,
                                                         java.lang.Class<V> valueType)

Creates a new argument representing a generic map.

Type Parameters:

K - The map key type

V - The map value type

Parameters:

keyType - The key type

valueType - The value type

Returns:

The argument instance

mapOf

@NonNull
static <K,V> Argument<java.util.Map<K,V>> mapOf(Argument<K> keyType,
                                                         Argument<V> valueType)

Creates a new argument representing a generic map.

Type Parameters:

K - The map key type

V - The map value type

Parameters:

keyType - The key type

valueType - The value type

Returns:

The argument instance

Since:

2.0.1