Module jakarta.cdi

Package jakarta.enterprise.inject.build.compatible.spi

Interface MethodConfig

All Superinterfaces:

DeclarationConfig

public interface MethodConfig
extends DeclarationConfig

Allows adding annotations to and removing annotations from a method. Note that the method is not physically altered, the modifications are only seen by the CDI container.

Since:

4.0

See Also:

Enhancement

Method Summary

Modifier and Type	Method	Description
MethodConfig	addAnnotation(AnnotationInfo annotation)	Adds given annotation to this method.
MethodConfig	addAnnotation(java.lang.annotation.Annotation annotation)	Adds given annotation to this method.
MethodConfig	addAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)	Adds a marker annotation of given type to this method.
MethodInfo	info()	Returns the MethodInfo corresponding to this transformed method.
java.util.List<ParameterConfig>	parameters()	Returns a list of ParameterConfig objects for each parameter of this method.
MethodConfig	removeAllAnnotations()	Removes all annotations from this method.
MethodConfig	removeAnnotation(java.util.function.Predicate<AnnotationInfo> predicate)	Removes all annotations matching given predicate from this method.

Method Detail

info

MethodInfo info()

Returns the MethodInfo corresponding to this transformed method.

Specified by:

info in interface DeclarationConfig

Returns:

the MethodInfo corresponding to this transformed method, never null

addAnnotation

MethodConfig addAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

Adds a marker annotation of given type to this method. Does not allow configuring annotation members.

Specified by:

addAnnotation in interface DeclarationConfig

Parameters:

annotationType - the annotation type, must not be null

Returns:

this configurator object, to allow fluent usage

addAnnotation

MethodConfig addAnnotation(AnnotationInfo annotation)

Adds given annotation to this method. The AnnotationInfo can be obtained from an annotation target, or constructed from scratch using AnnotationBuilder.

Specified by:

addAnnotation in interface DeclarationConfig

Parameters:

annotation - the annotation to add to this method, must not be null

Returns:

this configurator object, to allow fluent usage

addAnnotation

MethodConfig addAnnotation(java.lang.annotation.Annotation annotation)

Adds given annotation to this method. The annotation instance is typically a subclass of AnnotationLiteral.

Specified by:

addAnnotation in interface DeclarationConfig

Parameters:

annotation - the annotation to add to this method, must not be null

Returns:

this configurator object, to allow fluent usage

removeAnnotation

MethodConfig removeAnnotation(java.util.function.Predicate<AnnotationInfo> predicate)

Removes all annotations matching given predicate from this method.

Specified by:

removeAnnotation in interface DeclarationConfig

Parameters:

predicate - an annotation predicate, must not be null

Returns:

this configurator object, to allow fluent usage

removeAllAnnotations

MethodConfig removeAllAnnotations()

Removes all annotations from this method.

Specified by:

removeAllAnnotations in interface DeclarationConfig

Returns:

this configurator object, to allow fluent usage

parameters

java.util.List<ParameterConfig> parameters()

Returns a list of ParameterConfig objects for each parameter of this method.

Returns:

immutable list of ParameterConfig objects, never null