Spring Framework 6.1.4 · org.springframework.transaction.annotation.TransactionAnnotationParser

Strategy interface for parsing known transaction annotation types. AnnotationTransactionAttributeSource delegates to such parsers for supporting specific annotation types such as Spring's own Transactional, JTA 1.2's jakarta.transaction.Transactional or EJB3's jakarta.ejb.TransactionAttribute.

Method Summary

Modifier and Type	Method and Description
public default boolean	Returns: `false` if the class is known to have no transaction annotations at class or method level; `true` otherwise. The default implementation returns `true`, leading to regular introspection. isCandidateClass(Class<?> the class to introspect targetClass) Determine whether the given class is a candidate for transaction attributes in the annotation format of this `TransactionAnnotationParser`.
public TransactionAttribute	Returns: the configured transaction attribute, or `null` if none found parseTransactionAnnotation(AnnotatedElement the annotated method or class element) Parse the transaction attribute for the given method or class, based on an annotation type understood by this parser.

Method Detail

isCandidateClass back to summary

isCandidateClass	back to summary
public default boolean isCandidateClass(Class<?> targetClass) Determine whether the given class is a candidate for transaction attributes in the annotation format of this `TransactionAnnotationParser`. If this method returns `false`, the methods on the given class will not get traversed for `#parseTransactionAnnotation` introspection. Returning `false` is therefore an optimization for non-affected classes, whereas `true` simply means that the class needs to get fully introspected for each method on the given class individually. Parameters targetClass:Class<?> the class to introspect Returns:boolean `false` if the class is known to have no transaction annotations at class or method level; `true` otherwise. The default implementation returns `true`, leading to regular introspection. Since 5.2

public default boolean isCandidateClass(Class<?> targetClass)

Determine whether the given class is a candidate for transaction attributes in the annotation format of this TransactionAnnotationParser.

If this method returns false, the methods on the given class will not get traversed for #parseTransactionAnnotation introspection. Returning false is therefore an optimization for non-affected classes, whereas true simply means that the class needs to get fully introspected for each method on the given class individually.

Parameters

targetClass:Class<?>: the class to introspect

Returns:boolean

false if the class is known to have no transaction annotations at class or method level; true otherwise. The default implementation returns true, leading to regular introspection.

Since

5.2

parseTransactionAnnotation back to summary

parseTransactionAnnotation	back to summary
public TransactionAttribute parseTransactionAnnotation(AnnotatedElement element) Parse the transaction attribute for the given method or class, based on an annotation type understood by this parser. This essentially parses a known transaction annotation into Spring's metadata attribute class. Returns `null` if the method/class is not transactional. Parameters element:AnnotatedElement the annotated method or class Returns:TransactionAttribute the configured transaction attribute, or `null` if none found Annotations @Nullable See Also `AnnotationTransactionAttributeSource#determineTransactionAttribute`

public TransactionAttribute parseTransactionAnnotation(AnnotatedElement element)

Parse the transaction attribute for the given method or class, based on an annotation type understood by this parser.

This essentially parses a known transaction annotation into Spring's metadata attribute class. Returns null if the method/class is not transactional.

Parameters

element:AnnotatedElement: the annotated method or class

Returns:TransactionAttribute

the configured transaction attribute, or null if none found

Annotations

@Nullable

public Interface TransactionAnnotationParser

Method Summary

Method Detail