spring-framework / org.springframework.messaging.handler.annotation / DestinationVariable

DestinationVariable

@Target([AnnotationTarget.VALUE_PARAMETER]) class DestinationVariable

Annotation that indicates a method parameter should be bound to a template variable in a destination template string. Supported on message handling methods such as MessageMapping.

A @DestinationVariable template variable is always required.

Author
Brian Clozel

Author
Rossen Stoyanchev

Since
4.0

See Also
org.springframework.messaging.handler.annotation.MessageMappingorg.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler

Constructors

<init>

DestinationVariable(value: String)

Annotation that indicates a method parameter should be bound to a template variable in a destination template string. Supported on message handling methods such as MessageMapping.

A @DestinationVariable template variable is always required.

Properties

value

val value: String

The name of the destination template variable to bind to.