Package org.axonframework.messaging.core.annotation

Record Class AnnotationMessageTypeResolver.AnnotationSpecification

java.lang.Object

java.lang.Record

org.axonframework.messaging.core.annotation.AnnotationMessageTypeResolver.AnnotationSpecification

Record Components:

nameAnnotation - the annotation class to search for when AnnotationMessageTypeResolver.resolve(Class) is invoked for the nameAttribute specifically

nameAttribute - the attribute for the MessageType.name(), that should be present on the given annotation

versionAnnotation - the annotation class to search for when AnnotationMessageTypeResolver.resolve(Class) is invoked for the versionAttribute specifically

versionAttribute - the attribute for the MessageType.version(), that should be present on the given annotation

namespaceAnnotation - the annotation class to search for when AnnotationMessageTypeResolver.resolve(Class) is invoked for the namespaceAttribute specifically

namespaceAttribute - the attribute for the QualifiedName.namespace() field of the QualifiedName set in the resolved MessageType, or just the nameAttribute() if null

Enclosing class:

AnnotationMessageTypeResolver

public static record AnnotationMessageTypeResolver.AnnotationSpecification(Class<? extends Annotation> nameAnnotation, String nameAttribute, Class<? extends Annotation> versionAnnotation, String versionAttribute, Class<? extends Annotation> namespaceAnnotation, @Nullable String namespaceAttribute)
extends Record

An annotation specification unique to the AnnotationMessageTypeResolver.

Field Summary

Fields

Modifier and Type	Field	Description
static final AnnotationMessageTypeResolver.AnnotationSpecification	DEFAULT	The default AnnotationMessageTypeResolver.AnnotationSpecification that looks for the Message annotation for the nameAttribute() and versionAttribute(), and the Namespace annotation for the namespaceAttribute().

Constructor Summary

Constructors

Constructor	Description
AnnotationSpecification(Class<? extends Annotation> nameAnnotation, String nameAttribute, Class<? extends Annotation> versionAnnotation, String versionAttribute, Class<? extends Annotation> namespaceAnnotation, @Nullable String namespaceAttribute)	Creates an instance of a AnnotationSpecification record class.
AnnotationSpecification(Class<? extends Annotation> annotation, String nameAttribute, String versionAttribute, @Nullable String namespaceAttribute)	Deprecated. in favor of the AnnotationSpecification(Class, String, Class, String, Class, String) constructor that allows annotation configuration per resolvable attribute

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Class<? extends Annotation>	nameAnnotation()	Returns the value of the nameAnnotation record component.
String	nameAttribute()	Returns the value of the nameAttribute record component.
Class<? extends Annotation>	namespaceAnnotation()	Returns the value of the namespaceAnnotation record component.
@Nullable String	namespaceAttribute()	Returns the value of the namespaceAttribute record component.
final String	toString()	Returns a string representation of this record class.
Class<? extends Annotation>	versionAnnotation()	Returns the value of the versionAnnotation record component.
String	versionAttribute()	Returns the value of the versionAttribute record component.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final AnnotationMessageTypeResolver.AnnotationSpecification DEFAULT

The default AnnotationMessageTypeResolver.AnnotationSpecification that looks for the Message annotation for the nameAttribute() and versionAttribute(), and the Namespace annotation for the namespaceAttribute().

Constructor Details

AnnotationSpecification

@Deprecated(since="5.1.0")
public AnnotationSpecification(Class<? extends Annotation> annotation,
 String nameAttribute,
 String versionAttribute,
 @Nullable String namespaceAttribute)

Deprecated.

in favor of the AnnotationSpecification(Class, String, Class, String, Class, String) constructor that allows annotation configuration per resolvable attribute

An annotation specification unique to the AnnotationMessageTypeResolver.

Parameters:

annotation - the annotation class to search for when AnnotationMessageTypeResolver.resolve(Class) is invoked

nameAttribute - the attribute for the MessageType.name(), that should be present on the given annotation

versionAttribute - the attribute for the MessageType.version(), that should be present on the given annotation

namespaceAttribute - the attribute for the QualifiedName.namespace() field of the QualifiedName set in the resolved MessageType, or just the nameAttribute() if null

AnnotationSpecification

public AnnotationSpecification(Class<? extends Annotation> nameAnnotation,
 String nameAttribute,
 Class<? extends Annotation> versionAnnotation,
 String versionAttribute,
 Class<? extends Annotation> namespaceAnnotation,
 @Nullable String namespaceAttribute)

Creates an instance of a AnnotationSpecification record class.

Parameters:

nameAnnotation - the value for the nameAnnotation record component

nameAttribute - the value for the nameAttribute record component

versionAnnotation - the value for the versionAnnotation record component

versionAttribute - the value for the versionAttribute record component

namespaceAnnotation - the value for the namespaceAnnotation record component

namespaceAttribute - the value for the namespaceAttribute record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

nameAnnotation

public Class<? extends Annotation> nameAnnotation()

Returns the value of the nameAnnotation record component.

Returns:

the value of the nameAnnotation record component

nameAttribute

public String nameAttribute()

Returns the value of the nameAttribute record component.

Returns:

the value of the nameAttribute record component

versionAnnotation

public Class<? extends Annotation> versionAnnotation()

Returns the value of the versionAnnotation record component.

Returns:

the value of the versionAnnotation record component

versionAttribute

public String versionAttribute()

Returns the value of the versionAttribute record component.

Returns:

the value of the versionAttribute record component

namespaceAnnotation

public Class<? extends Annotation> namespaceAnnotation()

Returns the value of the namespaceAnnotation record component.

Returns:

the value of the namespaceAnnotation record component

namespaceAttribute

public @Nullable String namespaceAttribute()

Returns the value of the namespaceAttribute record component.

Returns:

the value of the namespaceAttribute record component