Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polish Javadoc for @SubscribeMapping

Browse Source
This commit is contained in:
Sam Brannen
2015-06-01 13:56:44 +02:00
parent a6f53ef2a7
commit 53d095aa28
1 changed files with 16 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
spring-messaging/src/main/java/org/springframework/messaging/simp/annotation/SubscribeMapping.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2013 the original author or authors.
* Copyright 2002-2015 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -27,22 +27,24 @@ import java.lang.annotation.Target;
* on the destination of a subscription. Supported with STOMP over WebSocket only
* (e.g. STOMP SUBSCRIBE frame).
*
* <p>This is a method-level annotations that can be combined with a type-level
* {@link org.springframework.messaging.handler.annotation.MessageMapping @MessageMapping}
* <p>This is a method-level annotation that can be combined with a type-level
* {@link org.springframework.messaging.handler.annotation.MessageMapping @MessageMapping}.
*
* <p>Supports the same method arguments as
* {@link org.springframework.messaging.handler.annotation.MessageMapping}, however
* <p>Supports the same method arguments as {@code @MessageMapping}; however,
* subscription messages typically do not have a body.
*
* <p>The return value also follows the same rules as for
* {@link org.springframework.messaging.handler.annotation.MessageMapping} except if
* the method is not annotated with
* {@link org.springframework.messaging.handler.annotation.SendTo} or {@link SendToUser},
* the message is sent directly back to the connected user and does not pass through
* the message broker. This is useful for implementing a request-reply pattern.
* <p>The return value also follows the same rules as for {@code @MessageMapping},
* except if the method is not annotated with
* {@link org.springframework.messaging.handler.annotation.SendTo SendTo} or
* {@link SendToUser}, the message is sent directly back to the connected
* user and does not pass through the message broker. This is useful for
* implementing a request-reply pattern.
*
* @author Rossen Stoyanchev
* @since 4.0
* @see org.springframework.messaging.handler.annotation.MessageMapping
* @see org.springframework.messaging.handler.annotation.SendTo
* @see org.springframework.messaging.simp.annotation.SendToUser
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@@ -51,9 +53,9 @@ public @interface SubscribeMapping {
/**
* Destination-based mapping expressed by this annotation.
* <p>For STOMP over WebSocket messages: this is the destination of the STOMP message
* (e.g. "/positions"). Ant-style path patterns (e.g. "/price.stock.*") are supported
* and so are path template variables (e.g. "/price.stock.{ticker}"").
* <p>This is the destination of the STOMP message (e.g. {@code "/positions"}).
* Ant-style path patterns (e.g. {@code "/price.stock.*"}) and path template
* variables (e.g. <code>"/price.stock.{ticker}"</code>) are also supported.
*/
String[] value() default {};