パッケージ jakarta.ws.rs

アノテーション型 FormParam


  • @TargetSE({PARAMETERSE,METHODSE,FIELDSE})
    @RetentionSE(RUNTIMESE)
    @DocumentedSE
    public @interface FormParam
    リクエストエンティティボディ内に含まれるフォームパラメーターの値をリソースメソッドパラメーターにバインドします。Encoded アノテーションを使用して無効にしない限り、値は URL デコードされます。デフォルト値は、DefaultValue アノテーションを使用して指定できます。リクエストエンティティの本文がないか、サポートされていないメディア型の場合は、デフォルト値が使用されます。アノテーション付きパラメーターの型 T は、以下のいずれかでなければなりません。
    1. プリミティブ型になる
    2. 単一の String 引数を受け入れるコンストラクターがある
    3. 単一の String 引数を受け入れる valueOf または fromString という名前の静的メソッドがある (たとえば、Integer.valueOf(String)SE を参照してください)
    4. 型の「文字列から」変換が可能な ParamConverter インスタンスを返す ParamConverterProvider JAX-RS 拡張 SPI の登録済み実装があります。
    5. List<T>Set<T>SortedSet<T> または T[] 配列であり、T は 2, 3 または上記 4 を満たします。結果のコレクションは読み取り専用です。

    型が上記の 5 にリストされたコレクション型の 1 つではなく、フォームパラメーターが複数の値で表される場合、パラメーターの最初の値(字句的に)が使用されます。

    このアノテーションを使用してフォームパラメーターをバインドする場合、JAX-RS 実装はエンティティプロバイダー API を使用して Form を作成し、このインスタンスから値を取得する必要があります。リソースメソッドに少なくとも 1 つの FormParam がある場合、JAX-RS 実装は同じメソッドの Form エンティティパラメーターをサポートする必要があります。他のエンティティパラメーター型のサポートはオプションです。

    アノテーションターゲットではフィールドとメソッドでの使用が許可されていますが、このアノテーションはリソースメソッドパラメーターでのみサポートされる必要があることに注意してください。

    導入:
    1.0
    作成者:
    Paul Sandoz, Marc Hadley
    関連事項:
    DefaultValue, Encoded
    • 必須定数のサマリー

      必須要素  
      修飾子と型 必須要素 説明
      StringSEvalue
      アノテーション付きメソッド引数の値を初期化するために使用される値を持つフォームパラメーターの名前を定義します。
    • 要素の詳細

      • value

        StringSE value
        アノテーション付きメソッド引数の値を初期化するために使用される値を持つフォームパラメーターの名前を定義します。名前はデコードされた形式で指定され、値内のパーセントエンコードされたリテラルはデコードされず、代わりにリテラルテキストとして扱われます。たとえば、パラメーター名が "ab" の場合、アノテーションの値は "ab" であり、 "a + b" や "a%20b" ではありません
        戻り値:
        フォームパラメーター名。