パッケージ jakarta.ws.rs.core

インターフェース EntityPart.Builder

  • 含まれているインターフェース:
    EntityPart
    public static interface EntityPart.Builder
    EntityPart インスタンスのビルダー。
    導入:
    3.1

    • メソッドの詳細

      • mediaType

        EntityPart.Builder mediaType​(MediaType mediaType)
                      throws IllegalArgumentExceptionSE
        EntityPart のメディア型を設定します。これにより、このパートの Content-Type ヘッダーも設定されます。
        パラメーター:
        mediaType - 作成するパーツのメディア型
        戻り値:
        更新されたビルダー
        例外:
        IllegalArgumentExceptionSE - mediaType が null の場合

      • mediaType

        EntityPart.Builder mediaType​(StringSE mediaTypeString)
                      throws IllegalArgumentExceptionSE
        EntityPart のメディア型を設定する便利なメソッド。これにより、このパートの Content-Type ヘッダーも設定されます。この呼び出しは実質的に mediaType(MediaType.valueOf(mediaTypeString)) と同じです。
        パラメーター:
        mediaTypeString - 作成するパーツのメディア型
        戻り値:
        更新されたビルダー
        例外:
        IllegalArgumentExceptionSE - mediaTypeString を解析できない場合、または null である場合

      • header

        EntityPart.Builder header​(StringSE headerName,
                          StringSE... headerValues)
                   throws IllegalArgumentExceptionSE
        新しいヘッダーを追加するか、以前に追加されたヘッダーを置き換えて、ヘッダー値を設定します。
        パラメーター:
        headerName - ヘッダー名
        headerValues - ヘッダー値
        戻り値:
        更新されたビルダー
        例外:
        IllegalArgumentExceptionSE - headerName が null の場合

      • fileName

        EntityPart.Builder fileName​(StringSE fileName)
                     throws IllegalArgumentExceptionSE
        このパーツのファイル名を設定します。ファイル名は、このパートの Content-Disposition ヘッダーの属性として指定されます。このメソッドが呼び出されると、特に指定されていない限り、ビルドされた部分に使用されるデフォルトのメディア型は "application/octet-stream" になります。
        パラメーター:
        fileName - このパートのファイル名
        戻り値:
        更新されたビルダー
        例外:
        IllegalArgumentExceptionSE - fileName が null の場合

      • content

        EntityPart.Builder content​(InputStreamSE content)
                    throws IllegalArgumentExceptionSE
        このパーツのコンテンツを設定します。build() メソッドを呼び出す前に、このビルダーの内容を指定する必要があります。

        InputStream は、マルチパートデータの送信後に実装コードによって閉じられます。送信前にストリームを閉じると、予期しない動作が発生する可能性があります。

        パラメーター:
        content - このパートの内容の InputStream 
        戻り値:
        更新されたビルダー
        例外:
        IllegalArgumentExceptionSE - content が null の場合

      • content

        default EntityPart.Builder content​(StringSE fileName,
                                   InputStreamSE content)
                            throws IllegalArgumentExceptionSE
        fileName(fileName).content(content) の呼び出しと同等の簡易メソッド。
        パラメーター:
        fileName - パーツのファイル名。
        content - パーツのコンテンツストリーム。
        戻り値:
        更新されたビルダー。
        例外:
        IllegalArgumentExceptionSE - いずれかのパラメーターが null の場合。

      • content

        default EntityPart.Builder content​(ObjectSE content)
                            throws IllegalArgumentExceptionSE
        このパーツのコンテンツを設定します。build() メソッドを呼び出す前に、このビルダーの内容を指定する必要があります。

        このメソッドを使用してコンテンツが指定されている場合、build() メソッドは、mediaType(MediaType) または mediaType(String) メソッドで指定されたデフォルトの MediaType または MediaType を使用し、指定された任意のヘッダーを使用して、ここで指定されたオブジェクトのクラス型を書き込むことができる登録済みの MessageBodyWriter を見つける責任があります。header(String, String...) または headers(MultivaluedMap) メソッド経由。

        これは、content(content, content.getClass()) を呼び出すのと同じです。

        パラメーター:
        content - コンテンツとして使用されるオブジェクト
        戻り値:
        更新されたビルダー。
        例外:
        IllegalArgumentExceptionSE - content が null の場合