io.micronaut.core.beans

Interface BeanProperty<B,T>

Type Parameters:

B - The bean type

T - The bean property type

All Superinterfaces:

AnnotatedElement, AnnotationMetadata, AnnotationMetadataDelegate, AnnotationMetadataProvider, AnnotationSource, Named

All Known Implementing Classes:

AbstractBeanProperty

@Immutable
public interface BeanProperty<B,T>
extends AnnotatedElement, AnnotationMetadataDelegate

Represents a bean property and associated annotation metadata.

A BeanProperty allows you to read the value of a property via get(Object) or write to it via set(Object, Object), without using reflection.

The annotations of a property can be inspected via the AnnotationMetadataProvider.getAnnotationMetadata() method.

Since:

1.1

Author:

graemerocher

See Also:

BeanIntrospection

Field Summary

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

CLASS_NAME_SUFFIX, EMPTY_METADATA, VALUE_MEMBER

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

EMPTY

Method Summary

Modifier and Type	Method and Description
default Argument<T>	asArgument() Represent the type as an argument, including any generic type information.
default void	convertAndSet(B bean, java.lang.Object value) Convert the value and set if on the bean using the default conversion service.
T	get(B bean) Read the bean value.
default <T2> java.util.Optional<T2>	get(B bean, Argument<T2> argument) Read the value and try to convert it to the given type.
default <T2> java.util.Optional<T2>	get(B bean, ArgumentConversionContext<T2> conversionContext) Read the value and try to convert it to the given type.
default <T2> java.util.Optional<T2>	get(B bean, java.lang.Class<T2> type) Read the value and try to convert it to the given type.
default <T2> T2	get(B bean, java.lang.Class<T2> type, T2 defaultValue) Read the value and try to convert it to the given type.
BeanIntrospection<B>	getDeclaringBean()
default java.lang.Class<B>	getDeclaringType() The declaring type of the property.
java.lang.Class<T>	getType()
default boolean	isReadOnly()
default boolean	isReadWrite() Whether the property can be written to and read from.
default boolean	isWriteOnly()
default void	set(B bean, T value) Write the bean value.

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

isDeclaredNonNull, isDeclaredNullable, isNonNull, isNullable

Methods inherited from interface io.micronaut.core.naming.Named

getName

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

booleanValue, booleanValue, booleanValue, booleanValue, classValue, classValue, classValue, classValue, classValues, classValues, classValues, classValues, doubleValue, doubleValue, doubleValue, enumValue, enumValue, enumValue, enumValue, enumValues, enumValues, enumValues, enumValues, findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, getAnnotation, getAnnotation, getAnnotationNameByStereotype, getAnnotationNameByStereotype, getAnnotationNames, getAnnotationNamesByStereotype, getAnnotationNamesByStereotype, getAnnotationType, getAnnotationTypeByStereotype, getAnnotationTypeByStereotype, getAnnotationTypesByStereotype, getAnnotationValuesByType, getDeclaredAnnotation, getDeclaredAnnotation, getDeclaredAnnotationNameByStereotype, getDeclaredAnnotationNames, getDeclaredAnnotationNamesByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationValuesByType, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValues, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValues, getValues, hasAnnotation, hasAnnotation, hasDeclaredAnnotation, hasDeclaredAnnotation, hasDeclaredStereotype, hasDeclaredStereotype, hasDeclaredStereotype, hasSimpleAnnotation, hasSimpleDeclaredAnnotation, hasStereotype, hasStereotype, hasStereotype, hasStereotype, intValue, intValue, intValue, isAnnotationPresent, isDeclaredAnnotationPresent, isEmpty, isFalse, isFalse, isPresent, isPresent, isTrue, isTrue, longValue, longValue, stringValue, stringValue, stringValue, stringValue, stringValues, stringValues, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

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

getAnnotationMetadata

Method Detail

getDeclaringBean

@NonNull
BeanIntrospection<B> getDeclaringBean()

Returns:

The declaring bean introspection.

get

@Nullable
T get(@NonNull
                B bean)

Read the bean value.

Parameters:

bean - The bean to read from

Returns:

The value

Throws:

java.lang.IllegalArgumentException - If the bean instance if not of the correct type

get

@NonNull
default <T2> java.util.Optional<T2> get(@NonNull
                                                 B bean,
                                                 @NonNull
                                                 java.lang.Class<T2> type)

Read the value and try to convert it to the given type.

Type Parameters:

T2 - The generic type

Parameters:

bean - The bean

type - The type

Returns:

The value if conversion was possible.

get

default <T2> java.util.Optional<T2> get(@NonNull
                                        B bean,
                                        @NonNull
                                        Argument<T2> argument)

Read the value and try to convert it to the given type.

Type Parameters:

T2 - The generic type

Parameters:

bean - The bean

argument - The type

Returns:

The value if conversion was possible.

get

default <T2> java.util.Optional<T2> get(@NonNull
                                        B bean,
                                        @NonNull
                                        ArgumentConversionContext<T2> conversionContext)

Read the value and try to convert it to the given type.

Type Parameters:

T2 - The generic type

Parameters:

bean - The bean

conversionContext - The conversion context to use

Returns:

The value if conversion was possible.

get

@Nullable
default <T2> T2 get(@NonNull
                              B bean,
                              @NonNull
                              java.lang.Class<T2> type,
                              @Nullable
                              T2 defaultValue)

Read the value and try to convert it to the given type.

Type Parameters:

T2 - The generic type

Parameters:

bean - The bean

type - The type

defaultValue - The default value if conversion is not possible

Returns:

The value if conversion was possible.

set

default void set(@NonNull
                 B bean,
                 @Nullable
                 T value)

Write the bean value.

Parameters:

bean - The bean

value - The value to write

Throws:

java.lang.IllegalArgumentException - If either the bean type or value type are not correct

convertAndSet

default void convertAndSet(@NonNull
                           B bean,
                           @Nullable
                           java.lang.Object value)

Convert the value and set if on the bean using the default conversion service.

Parameters:

bean - The bean

value - The value

Throws:

ConversionErrorException - If the value couldn't be converted

getType

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

Returns:

The property type.

asArgument

default Argument<T> asArgument()

Represent the type as an argument, including any generic type information.

Returns:

The argument

isReadOnly

default boolean isReadOnly()

Returns:

Whether the property is read-only

isWriteOnly

default boolean isWriteOnly()

Returns:

Whether the property is write-only

isReadWrite

default boolean isReadWrite()

Whether the property can be written to and read from.

Returns:

True if it can.

getDeclaringType

default java.lang.Class<B> getDeclaringType()

The declaring type of the property.

Returns:

The type