Skip navigation links
Spring Framework
  • Summary: 
  • Field | 
  • Required | 
  • Optional
org.springframework.messaging.handler.annotation

Annotation Type Header


  • @Target(value=PARAMETER)
 @Retention(value=RUNTIME)
 @Documented
public @interface Header
    Annotation which indicates that a method parameter should be bound to a message header.
    Since:
    4.0
    Author:
    Rossen Stoyanchev, Sam Brannen

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element and Description
      java.lang.String defaultValue
      The default value to use as a fallback.
      java.lang.String name
      The name of the request header to bind to.
      boolean required
      Whether the header is required.
      java.lang.String value
      Alias for name().

    • Element Detail

      • value

        @AliasFor(value="name")
public abstract java.lang.String value
        Alias for name().
        Default:
        ""

      • name

        @AliasFor(value="value")
public abstract java.lang.String name
        The name of the request header to bind to.
        Since:
        4.2
        Default:
        ""

      • required

        public abstract boolean required
        Whether the header is required.

        Default is true, leading to an exception if the header is missing. Switch this to false if you prefer a null value in case of a header missing.

        See Also:
        defaultValue()
        Default:
        true

      • defaultValue

        public abstract java.lang.String defaultValue
        The default value to use as a fallback.

        Supplying a default value implicitly sets required() to false.

        Default:
        "\n\t\t\n\t\t\n\ue000\ue001\ue002\n\t\t\t\t\n"
Skip navigation links
Spring Framework
  • Summary: 
  • Field | 
  • Required | 
  • Optional


Impressum und Datenschutz    Copyright ©2018 eir.me