Package io.micronaut.core.type

Class DefaultArgument<T>

java.lang.Object

io.micronaut.core.type.DefaultArgument<T>

Type Parameters:

T - The argument type

All Implemented Interfaces:

AnnotatedElement, AnnotationMetadataProvider, AnnotationSource, Named, Argument<T>, ArgumentCoercible<T>, TypeInformation<T>, TypeVariableResolver, Type

Direct Known Subclasses:

GenericArgument

@Internal
public class DefaultArgument<T>
extends Object
implements Argument<T>, ArgumentCoercible<T>

Represents an argument to a constructor or method.

Since:

1.0

Author:

Graeme Rocher

Nested Class Summary

Nested classes/interfaces inherited from interface io.micronaut.core.type.TypeInformation

TypeInformation.TypeFormat

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	CONTAINER_TYPES
static final Set<String>	PROVIDER_TYPES

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

EMPTY

Fields inherited from interface io.micronaut.core.type.Argument

BOOLEAN, BYTE, CHAR, DOUBLE, FLOAT, INT, LIST_OF_STRING, LONG, OBJECT_ARGUMENT, SHORT, STRING, VOID, VOID_OBJECT, ZERO_ARGUMENTS

Constructor Summary

Constructors

Modifier	Constructor	Description
	DefaultArgument(Class<T> type, AnnotationMetadata annotationMetadata, Argument<?>... genericTypes)
	DefaultArgument(Class<T> type, String name, AnnotationMetadata annotationMetadata, boolean isTypeVariable, Argument<?>... genericTypes)
	DefaultArgument(Class<T> type, String name, AnnotationMetadata annotationMetadata, Argument<?>... genericTypes)
	DefaultArgument(Class<T> type, String name, AnnotationMetadata annotationMetadata, Map<String,Argument<?>> typeParameters, Argument<?>[] typeParameterArray)
protected	DefaultArgument(Class<T> type, String name, AnnotationMetadata annotationMetadata, Map<String,Argument<?>> typeParameters, Argument<?>[] typeParameterArray, boolean isTypeVariable)
	DefaultArgument(Type type, String name, AnnotationMetadata annotationMetadata)

Method Summary

Modifier and Type	Method	Description
@NonNull Argument<T>	asArgument()
boolean	equals(Object o)
boolean	equalsType(@Nullable Argument<?> o)	Whether the types are equivalent.
AnnotationMetadata	getAnnotationMetadata()	Supplies the metadata.
Optional<Argument<?>>	getFirstTypeVariable()
@NonNull String	getName()
@NonNull Class<T>	getType()
Argument[]	getTypeParameters()
Map<String,Argument<?>>	getTypeVariables()
int	hashCode()
boolean	isReactive()
boolean	isTypeVariable()	Whether this argument is a type variable used in generics.
String	toString()
int	typeHashCode()	The hash code including only the types.
Argument<T>	withAnnotationMetadata(AnnotationMetadata annotationMetadata)	Creates a copy of this argument with a different annotation metadata.
Argument<T>	withName(String name)	Creates a copy of this argument with a different name.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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, getTargetAnnotationMetadata, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

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

getAnnotation, getAnnotation, getDeclaredAnnotation, getDeclaredAnnotation, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeDeclared

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

isAssignableFrom, isAssignableFrom, isInstance

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

asParameterizedType, asType, getBeanTypeString, getSimpleName, getTypeName, getTypeString, getTypeString, getWrappedType, getWrapperType, hasTypeVariables, isArray, isAsync, isAsyncOrReactive, isCompletable, isContainerType, isOptional, isPrimitive, isProvider, isSpecifiedSingle, isVoid, isWrapperType

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

getTypeVariable

Field Details

CONTAINER_TYPES

public static final Set<String> CONTAINER_TYPES

PROVIDER_TYPES

public static final Set<String> PROVIDER_TYPES

Constructor Details

DefaultArgument

public DefaultArgument(Class<T> type,
 String name,
 AnnotationMetadata annotationMetadata,
 Argument<?>... genericTypes)

Parameters:

type - The type

name - The name

annotationMetadata - The annotation metadata

genericTypes - The generic types

DefaultArgument

public DefaultArgument(Class<T> type,
 AnnotationMetadata annotationMetadata,
 Argument<?>... genericTypes)

Parameters:

type - The type

annotationMetadata - The annotation metadata

genericTypes - The generic types

DefaultArgument

public DefaultArgument(Class<T> type,
 String name,
 AnnotationMetadata annotationMetadata,
 Map<String,Argument<?>> typeParameters,
 Argument<?>[] typeParameterArray)

Parameters:

type - The type

name - The name

annotationMetadata - The annotation metadata

typeParameters - The map of parameters

typeParameterArray - The array of arguments

DefaultArgument

public DefaultArgument(Class<T> type,
 String name,
 AnnotationMetadata annotationMetadata,
 boolean isTypeVariable,
 Argument<?>... genericTypes)

Parameters:

type - The type

name - The name

annotationMetadata - The annotation metadata

isTypeVariable - Is this argument a type variable

genericTypes - The generic types

DefaultArgument

protected DefaultArgument(Class<T> type,
 String name,
 AnnotationMetadata annotationMetadata,
 Map<String,Argument<?>> typeParameters,
 Argument<?>[] typeParameterArray,
 boolean isTypeVariable)

Parameters:

type - The type

name - The name

annotationMetadata - The annotation metadata

typeParameters - The map of parameters

typeParameterArray - The array of arguments

isTypeVariable - Is the argument a type variable

DefaultArgument

public DefaultArgument(Type type,
 String name,
 AnnotationMetadata annotationMetadata)

Parameters:

type - The type

name - The name

annotationMetadata - The annotation metadata

Method Details

withName

public Argument<T> withName(String name)

Description copied from interface: Argument

Creates a copy of this argument with a different name.

Specified by:

withName in interface Argument<T>

Parameters:

name - The new name

Returns:

A new argument

withAnnotationMetadata

public Argument<T> withAnnotationMetadata(AnnotationMetadata annotationMetadata)

Description copied from interface: Argument

Creates a copy of this argument with a different annotation metadata.

Specified by:

withAnnotationMetadata in interface Argument<T>

Parameters:

annotationMetadata - The annotation metadata

Returns:

A new argument

isTypeVariable

public boolean isTypeVariable()

Description copied from interface: Argument

Whether this argument is a type variable used in generics.

Specified by:

isTypeVariable in interface Argument<T>

Returns:

True if it is a variable

getAnnotationMetadata

public AnnotationMetadata getAnnotationMetadata()

Description copied from interface: AnnotationMetadataProvider

Supplies the metadata. Defaults to AnnotationMetadata.EMPTY_METADATA.

Specified by:

getAnnotationMetadata in interface AnnotationMetadataProvider

Returns:

The AnnotationMetadata

getFirstTypeVariable

public Optional<Argument<?>> getFirstTypeVariable()

Specified by:

getFirstTypeVariable in interface TypeVariableResolver

Returns:

Return the first type parameter if it is present

getTypeParameters

public Argument[] getTypeParameters()

Specified by:

getTypeParameters in interface TypeVariableResolver

Returns:

The type parameters as an array

getTypeVariables

public Map<String,Argument<?>> getTypeVariables()

Specified by:

getTypeVariables in interface TypeVariableResolver

Returns:

Obtain a map of the type parameters for the argument

getType

@NonNull
public @NonNull Class<T> getType()

Specified by:

getType in interface TypeInformation<T>

Returns:

The type

isReactive

public boolean isReactive()

Specified by:

isReactive in interface TypeInformation<T>

Returns:

Is the return type reactive.

getName

@NonNull
public @NonNull String getName()

Specified by:

getName in interface Argument<T>

Specified by:

getName in interface Named

Returns:

The name of the argument

toString

public String toString()

Overrides:

toString in class Object

equalsType

public boolean equalsType(@Nullable
 @Nullable Argument<?> o)

Description copied from interface: Argument

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.

Specified by:

equalsType in interface Argument<T>

Parameters:

o - The type

Returns:

True if they are equal

equals

public boolean equals(Object o)

Overrides:

equals in class Object

typeHashCode

public int typeHashCode()

Description copied from interface: Argument

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.

Specified by:

typeHashCode in interface Argument<T>

Returns:

The type hash code

hashCode

public int hashCode()

Overrides:

hashCode in class Object

asArgument

@NonNull
public @NonNull Argument<T> asArgument()

Specified by:

asArgument in interface ArgumentCoercible<T>

Returns:

The argument