Spring Framework 6.1.4 · org.springframework.aot.hint.ReflectionHints

Modifier and Type	Field and Description
private final Map<TypeReference, TypeHint.Builder>	types

Access	Constructor and Description
public	ReflectionHints()

Method Summary

Modifier and Type	Method and Description
public TypeHint	Returns: the reflection hints for this type, or `null` getTypeHint(TypeReference the type to inspect type) Return the reflection hints for the type defined by the specified `TypeReference`.
public TypeHint	Returns: the reflection hints for this type, or `null` getTypeHint(Class<?> the type to inspect type) Return the reflection hints for the specified type.
private List<TypeReference>	mapParameters(Executable executable)
public ReflectionHints	Returns: `this`, to facilitate method chaining registerConstructor(Constructor<?> the constructor that requires reflection constructor, ExecutableMode the requested mode mode) Register the need for reflection on the specified `Constructor`, using the specified `ExecutableMode`.
public ReflectionHints	Returns: `this`, to facilitate method chaining registerField(Field the field that requires reflection field) Register the need for reflection on the specified `Field`.
public ReflectionHints	Returns: `this`, to facilitate method chaining registerMethod(Method the method that requires reflection method, ExecutableMode the requested mode mode) Register the need for reflection on the specified `Method`, using the specified `ExecutableMode`.
public ReflectionHints	Returns: `this`, to facilitate method chaining registerType(TypeReference the type to customize type, Consumer<TypeHint.Builder> a builder to further customize hints for that type typeHint) Register or customize reflection hints for the type defined by the specified `TypeReference`.
public ReflectionHints	Returns: `this`, to facilitate method chaining registerType(TypeReference the type to customize type, MemberCategory... the member categories to apply memberCategories) Register or customize reflection hints for the specified type using the specified `MemberCategories`.
public ReflectionHints	Returns: `this`, to facilitate method chaining registerType(Class<?> the type to customize type, Consumer<TypeHint.Builder> a builder to further customize hints for that type typeHint) Register or customize reflection hints for the specified type.
public ReflectionHints	Returns: `this`, to facilitate method chaining registerType(Class<?> the type to customize type, MemberCategory... the member categories to apply memberCategories) Register or customize reflection hints for the specified type using the specified `MemberCategories`.
public ReflectionHints	Returns: `this`, to facilitate method chaining registerTypeIfPresent(ClassLoader the classloader to use to check if the type is present classLoader, String the type to customize typeName, Consumer<TypeHint.Builder> a builder to further customize hints for that type typeHint) Register or customize reflection hints for the specified type if it is available using the specified `ClassLoader`.
public ReflectionHints	Returns: `this`, to facilitate method chaining registerTypeIfPresent(ClassLoader the classloader to use to check if the type is present classLoader, String the type to customize typeName, MemberCategory... the member categories to apply memberCategories) Register or customize reflection hints for the specified type if it is available using the specified `ClassLoader`.
public ReflectionHints	Returns: `this`, to facilitate method chaining registerTypes(Iterable<TypeReference> the types to customize types, Consumer<TypeHint.Builder> a builder to further customize hints for each type typeHint) Register or customize reflection hints for the types defined by the specified list of `type references`.
public Stream<TypeHint>	Returns: the type hints typeHints() Return the types that require reflection.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

types	back to summary
private final Map<TypeReference, TypeHint.Builder> types

ReflectionHints	back to summary
public ReflectionHints()

Method Detail

getTypeHint back to summary

getTypeHint	back to summary
public TypeHint getTypeHint(TypeReference type) Return the reflection hints for the type defined by the specified `TypeReference`. Parameters type:TypeReference the type to inspect Returns:TypeHint the reflection hints for this type, or `null` Annotations @Nullable

public TypeHint getTypeHint(TypeReference type)

Return the reflection hints for the type defined by the specified TypeReference.

Parameters

type:TypeReference: the type to inspect

Returns:TypeHint

the reflection hints for this type, or null

Annotations

@Nullable

getTypeHint back to summary

getTypeHint	back to summary
public TypeHint getTypeHint(Class<?> type) Return the reflection hints for the specified type. Parameters type:Class<?> the type to inspect Returns:TypeHint the reflection hints for this type, or `null` Annotations @Nullable

public TypeHint getTypeHint(Class<?> type)

Return the reflection hints for the specified type.

Parameters

type:Class<?>: the type to inspect

Returns:TypeHint

the reflection hints for this type, or null

Annotations

@Nullable

mapParameters	back to summary
private List<TypeReference> mapParameters(Executable executable)

registerConstructor back to summary

registerConstructor	back to summary
public ReflectionHints registerConstructor(Constructor<?> constructor, ExecutableMode mode) Register the need for reflection on the specified `Constructor`, using the specified `ExecutableMode`. Parameters constructor:Constructor<?> the constructor that requires reflection mode:ExecutableMode the requested mode Returns:ReflectionHints `this`, to facilitate method chaining

public ReflectionHints registerConstructor(Constructor<?> constructor, ExecutableMode mode)

Parameters

constructor:Constructor<?>: the constructor that requires reflection
mode:ExecutableMode: the requested mode

Returns:ReflectionHints

this, to facilitate method chaining

registerField back to summary

registerField	back to summary
public ReflectionHints registerField(Field field) Register the need for reflection on the specified `Field`. Parameters field:Field the field that requires reflection Returns:ReflectionHints `this`, to facilitate method chaining

public ReflectionHints registerField(Field field)

Parameters

field:Field: the field that requires reflection

Returns:ReflectionHints

this, to facilitate method chaining

registerMethod back to summary

registerMethod	back to summary
public ReflectionHints registerMethod(Method method, ExecutableMode mode) Register the need for reflection on the specified `Method`, using the specified `ExecutableMode`. Parameters method:Method the method that requires reflection mode:ExecutableMode the requested mode Returns:ReflectionHints `this`, to facilitate method chaining

public ReflectionHints registerMethod(Method method, ExecutableMode mode)

Parameters

method:Method: the method that requires reflection
mode:ExecutableMode: the requested mode

Returns:ReflectionHints

this, to facilitate method chaining

registerType back to summary

registerType	back to summary
public ReflectionHints registerType(TypeReference type, Consumer<TypeHint.Builder> typeHint) Register or customize reflection hints for the type defined by the specified `TypeReference`. Parameters type:TypeReference the type to customize typeHint:Consumer<TypeHint.Builder> a builder to further customize hints for that type Returns:ReflectionHints `this`, to facilitate method chaining See Also `registerType(TypeReference, MemberCategory...)`

public ReflectionHints registerType(TypeReference type, Consumer<TypeHint.Builder> typeHint)

Parameters

type:TypeReference: the type to customize
typeHint:Consumer<TypeHint.Builder>: a builder to further customize hints for that type

Returns:ReflectionHints

this, to facilitate method chaining

registerType back to summary

registerType	back to summary
public ReflectionHints registerType(TypeReference type, MemberCategory... memberCategories) Register or customize reflection hints for the specified type using the specified `MemberCategories`. Parameters type:TypeReference the type to customize memberCategories:MemberCategory[] the member categories to apply Returns:ReflectionHints `this`, to facilitate method chaining

public ReflectionHints registerType(TypeReference type, MemberCategory... memberCategories)

Parameters

type:TypeReference: the type to customize
memberCategories:MemberCategory[]: the member categories to apply

Returns:ReflectionHints

this, to facilitate method chaining

registerType back to summary

registerType	back to summary
public ReflectionHints registerType(Class<?> type, Consumer<TypeHint.Builder> typeHint) Register or customize reflection hints for the specified type. Parameters type:Class<?> the type to customize typeHint:Consumer<TypeHint.Builder> a builder to further customize hints for that type Returns:ReflectionHints `this`, to facilitate method chaining See Also `registerType(Class, MemberCategory...)`

public ReflectionHints registerType(Class<?> type, Consumer<TypeHint.Builder> typeHint)

Parameters

type:Class<?>: the type to customize
typeHint:Consumer<TypeHint.Builder>: a builder to further customize hints for that type

Returns:ReflectionHints

this, to facilitate method chaining

registerType back to summary

registerType	back to summary
public ReflectionHints registerType(Class<?> type, MemberCategory... memberCategories) Register or customize reflection hints for the specified type using the specified `MemberCategories`. Parameters type:Class<?> the type to customize memberCategories:MemberCategory[] the member categories to apply Returns:ReflectionHints `this`, to facilitate method chaining

public ReflectionHints registerType(Class<?> type, MemberCategory... memberCategories)

Parameters

type:Class<?>: the type to customize
memberCategories:MemberCategory[]: the member categories to apply

Returns:ReflectionHints

this, to facilitate method chaining

registerTypeIfPresent back to summary

registerTypeIfPresent	back to summary
public ReflectionHints registerTypeIfPresent(ClassLoader classLoader, String typeName, Consumer<TypeHint.Builder> typeHint) Register or customize reflection hints for the specified type if it is available using the specified `ClassLoader`. Parameters classLoader:ClassLoader the classloader to use to check if the type is present typeName:String the type to customize typeHint:Consumer<TypeHint.Builder> a builder to further customize hints for that type Returns:ReflectionHints `this`, to facilitate method chaining See Also `registerTypeIfPresent(ClassLoader, String, MemberCategory...)`

public ReflectionHints registerTypeIfPresent(ClassLoader classLoader, String typeName, Consumer<TypeHint.Builder> typeHint)

Parameters

classLoader:ClassLoader: the classloader to use to check if the type is present
typeName:String: the type to customize
typeHint:Consumer<TypeHint.Builder>: a builder to further customize hints for that type

Returns:ReflectionHints

this, to facilitate method chaining

registerTypeIfPresent back to summary

registerTypeIfPresent	back to summary
public ReflectionHints registerTypeIfPresent(ClassLoader classLoader, String typeName, MemberCategory... memberCategories) Register or customize reflection hints for the specified type if it is available using the specified `ClassLoader`. Parameters classLoader:ClassLoader the classloader to use to check if the type is present typeName:String the type to customize memberCategories:MemberCategory[] the member categories to apply Returns:ReflectionHints `this`, to facilitate method chaining

public ReflectionHints registerTypeIfPresent(ClassLoader classLoader, String typeName, MemberCategory... memberCategories)

Parameters

classLoader:ClassLoader: the classloader to use to check if the type is present
typeName:String: the type to customize
memberCategories:MemberCategory[]: the member categories to apply

Returns:ReflectionHints

this, to facilitate method chaining

registerTypes back to summary

registerTypes	back to summary
public ReflectionHints registerTypes(Iterable<TypeReference> types, Consumer<TypeHint.Builder> typeHint) Register or customize reflection hints for the types defined by the specified list of `type references`. The specified `typeHint` consumer is invoked for each type. Parameters types:Iterable<TypeReference> the types to customize typeHint:Consumer<TypeHint.Builder> a builder to further customize hints for each type Returns:ReflectionHints `this`, to facilitate method chaining

public ReflectionHints registerTypes(Iterable<TypeReference> types, Consumer<TypeHint.Builder> typeHint)

Register or customize reflection hints for the types defined by the specified list of type references. The specified typeHint consumer is invoked for each type.

Parameters

types:Iterable<TypeReference>: the types to customize
typeHint:Consumer<TypeHint.Builder>: a builder to further customize hints for each type

Returns:ReflectionHints

this, to facilitate method chaining

typeHints	back to summary
public Stream<TypeHint> typeHints() Return the types that require reflection. Returns:Stream<TypeHint> the type hints

typeHints

back to summary

public Stream<TypeHint> typeHints()

Return the types that require reflection.

Returns:Stream<TypeHint>: the type hints

public Class ReflectionHints

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail