パッケージ org.springframework.web.bind.annotation

アノテーションインターフェース MatrixVariable

@TargetSE(PARAMETERSE) @RetentionSE(RUNTIMESE) @DocumentedSE public @interface MatrixVariable
メソッドパラメーターをパスセグメント内の名前と値のペアにバインドする必要があることを示すアノテーション。RequestMapping アノテーション付きハンドラーメソッドでサポートされます。

メソッドのパラメーター型が MapSE で、マトリックス変数名が指定されている場合、適切な変換戦略が利用可能であると仮定して、マトリックス変数値は MapSE に変換されます。

メソッドパラメーターが Map<String, String>SE または MultiValueMap<String, String> で、変数名が指定されていない場合、マップにはすべてのマトリックス変数名と値が入力されます。

導入:
3.2
作成者:
Rossen Stoyanchev, Sam Brannen

  • オプション要素の概要

    オプション要素
    修飾子と型
    オプションの要素
    説明
    StringSE
    defaultValue
    フォールバックとして使用するデフォルト値。
    StringSE
    name
    マトリックス変数の名前。
    StringSE
    pathVar
    マトリックス変数が配置されている URI パス変数の名前 (たとえば、複数のパスセグメントに同じ名前のマトリックス変数が存在する場合)。
    boolean
    required
    マトリックス変数が必要かどうか。
    StringSE
    value
    name() のエイリアス。

  • 要素の詳細

    • value

      @AliasFor("name") StringSE value
      name() のエイリアス。
      デフォルト:
      ""

    • name

      @AliasFor("value") StringSE name
      マトリックス変数の名前。
      導入:
      4.2
      関連事項:
      デフォルト:
      ""

    • pathVar

      StringSE pathVar
      マトリックス変数が配置されている URI パス変数の名前 (たとえば、複数のパスセグメントに同じ名前のマトリックス変数が存在する場合)。
      デフォルト:
      "\n\t\t\n\t\t\n\ue000\ue001\ue002\n\t\t\t\t\n"

    • required

      boolean required
      マトリックス変数が必要かどうか。

      デフォルトは true であり、リクエストで変数が欠落している場合に例外がスローされます。変数が欠落している場合に null を使用する場合は、これを false に切り替えます。

      または、defaultValue() を指定します。これにより、このフラグが暗黙的に false に設定されます。

      デフォルト:
      true

    • defaultValue

      StringSE defaultValue
      フォールバックとして使用するデフォルト値。

      デフォルト値を指定すると、required() が false に暗黙的に設定されます。

      デフォルト:
      "\n\t\t\n\t\t\n\ue000\ue001\ue002\n\t\t\t\t\n"