Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
 /*
  * Copyright 2002-2012 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.
  * You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.messaging.handler.annotation;
Annotation that binds a method parameter to the payload of a message. The payload may be passed through a org.springframework.messaging.converter.MessageConverter to convert it from serialized form with a specific MIME type to an Object matching the target method parameter.

Author(s):
Rossen Stoyanchev
Since:
4.0
public @interface Payload {

A SpEL expression to be evaluated against the payload object as the root context. This attribute may or may not be supported depending on whether the message being handled contains a non-primitive Object as its payload or is in serialized form and requires message conversion.

When processing STOMP over WebSocket messages this attribute is not supported.

	String value() default "";

Whether payload content is required.

Default is true, leading to an exception if there is no payload. Switch to false to have null passed when there is no payload.

	boolean required() default true;
New to GrepCode? Check out our FAQ X