パッケージ org.springframework.http

クラス MediaType

java.lang.ObjectSE
org.springframework.util.MimeType
org.springframework.http.MediaType
実装されたすべてのインターフェース:
SerializableSE, ComparableSE<MimeType>
public class MediaType extends MimeType implements SerializableSE
HTTP 仕様で定義されている品質パラメーターのサポートを追加する MimeType のサブクラス。
導入:
3.0
作成者:
Arjen Poutsma, Juergen Hoeller, Rossen Stoyanchev, Sebastien Deleuze, Kazuki Shimizu, Sam Brannen
関連事項:

  • フィールドの詳細

  • コンストラクターの詳細

    • MediaType

      public MediaType(StringSE type)
      指定されたプライマリ型の新しい MediaType を作成します。

      サブ型は "*" に設定され、パラメーターは空です。

      パラメーター:
      type - プライマリ型
      例外:
      IllegalArgumentExceptionSE - パラメーターに不正な文字が含まれている場合

    • MediaType

      public MediaType(StringSE type, StringSE subtype)
      指定されたプライマリ型とサブ型の新しい MediaType を作成します。

      パラメーターは空です。

      パラメーター:
      type - プライマリ型
      subtype - サブ型
      例外:
      IllegalArgumentExceptionSE - パラメーターに不正な文字が含まれている場合

    • MediaType

      public MediaType(StringSE type, StringSE subtype, CharsetSE charset)
      指定された型、サブ型、文字セットの新しい MediaType を作成します。
      パラメーター:
      type - プライマリ型
      subtype - サブ型
      charset - 文字セット
      例外:
      IllegalArgumentExceptionSE - パラメーターに不正な文字が含まれている場合

    • MediaType

      public MediaType(StringSE type, StringSE subtype, double qualityValue)
      指定された型、サブ型、品質値の新しい MediaType を作成します。
      パラメーター:
      type - プライマリ型
      subtype - サブ型
      qualityValue - 品質価値
      例外:
      IllegalArgumentExceptionSE - パラメーターに不正な文字が含まれている場合

    • MediaType

      public MediaType(MediaType other, CharsetSE charset)
      指定された MediaType の型、サブ型、パラメーターをコピーし、指定された文字セットを設定できるコピーコンストラクター。
      パラメーター:
      other - 他のメディア型
      charset - 文字セット
      例外:
      IllegalArgumentExceptionSE - パラメーターに不正な文字が含まれている場合
      導入:
      4.3

    • MediaType

      public MediaType(MediaType other, @Nullable MapSE<StringSE,StringSE> parameters)
      指定された MediaType の型とサブ型をコピーし、異なるパラメーターを許可するコピーコンストラクター。
      パラメーター:
      other - 他のメディア型
      parameters - パラメーターは、null の場合があります
      例外:
      IllegalArgumentExceptionSE - パラメーターに不正な文字が含まれている場合

    • MediaType

      public MediaType(StringSE type, StringSE subtype, @Nullable MapSE<StringSE,StringSE> parameters)
      指定された型、サブ型、パラメーターの新しい MediaType を作成します。
      パラメーター:
      type - プライマリ型
      subtype - サブ型
      parameters - パラメーターは、null の場合があります
      例外:
      IllegalArgumentExceptionSE - パラメーターに不正な文字が含まれている場合

    • MediaType

      public MediaType(MimeType mimeType)
      指定された MimeType に対して新しい MediaType を作成します。型、サブ型、パラメーターの情報がコピーされ、パラメーターの MediaType -specific チェックが実行されます。
      パラメーター:
      mimeType - MIME 型
      例外:
      IllegalArgumentExceptionSE - パラメーターに不正な文字が含まれている場合
      導入:
      5.3

  • メソッドの詳細

    • checkParameters

      protected void checkParameters(StringSE parameter, StringSE value)
      オーバーライド:
      クラス MimeType の checkParameters 

    • getQualityValue

      public double getQualityValue()
      q パラメーターで示される品質係数があれば、それを返します。デフォルトは 1.0 です。
      戻り値:
      二重値としての品質係数

    • isMoreSpecific

      public boolean isMoreSpecific(MimeType other)
      この MediaType が特定の型よりも具体的かどうかを示します。
      1. このメディア型の品質係数が他のメディア型よりも高い場合、このメソッドは true を返します。
      2. このメディア型の品質係数が他のメディア型よりも低い場合、このメソッドは false を返します。
      3. この MIME 型にワイルドカード型があり、もう一方にない場合、このメソッドは false を返します。
      4. この MIME 型にはワイルドカード型がなく、もう一方にはワイルドカード型がある場合、このメソッドは true を返します。
      5. この MIME 型にワイルドカード型があり、もう一方にない場合、このメソッドは false を返します。
      6. この MIME 型にはワイルドカード型がなく、もう一方にはワイルドカード型がある場合、このメソッドは true を返します。
      7. 2 つの MIME 型の type と subtype が同一である場合、パラメーターが最も多い MIME 型が他の MIME 型よりも具体的です。
      8. それ以外の場合、このメソッドは false を返します。
      オーバーライド:
      クラス MimeType の isMoreSpecific 
      パラメーター:
      other - 比較する MimeType 
      戻り値:
      比較の結果
      導入:
      6.0
      関連事項:

    • isLessSpecific

      public boolean isLessSpecific(MimeType other)
      この MediaType が特定の型よりも具体的かどうかを示します。
      1. このメディア型の品質係数が他のメディア型よりも高い場合、このメソッドは false を返します。
      2. このメディア型の品質係数が他のメディア型よりも低い場合、このメソッドは true を返します。
      3. この MIME 型にワイルドカード型があり、もう一方にない場合、このメソッドは true を返します。
      4. この MIME 型にはワイルドカード型がなく、もう一方にはワイルドカード型がある場合、このメソッドは false を返します。
      5. この MIME 型にワイルドカード型があり、もう一方にない場合、このメソッドは true を返します。
      6. この MIME 型にはワイルドカード型がなく、もう一方にはワイルドカード型がある場合、このメソッドは false を返します。
      7. 2 つの MIME 型の type と subtype が同一である場合、パラメーターが最も少ない MIME 型は、他の型よりも具体的ではありません。
      8. それ以外の場合、このメソッドは false を返します。
      オーバーライド:
      クラス MimeType の isLessSpecific 
      パラメーター:
      other - 比較する MimeType 
      戻り値:
      比較の結果
      導入:
      6.0
      関連事項:

    • includes

      public boolean includes(@Nullable MediaType other)
      この MediaType に特定のメディア型が含まれているかどうかを示します。

      たとえば、text/* には text/plain と text/html が含まれ、application/*+xml には application/soap+xml などが含まれます。この方法は対称ではありません。

      単に MimeType.includes(MimeType) を呼び出しますが、バイナリの後方互換性のために MediaType パラメーターで宣言されています。

      パラメーター:
      other - 比較する参照メディア型
      戻り値:
      このメディア型に特定のメディア型が含まれる場合は true。それ以外の場合は false 

    • isCompatibleWith

      public boolean isCompatibleWith(@Nullable MediaType other)
      この MediaType が指定されたメディア型と互換性があるかどうかを示します。

      たとえば、text/* は text/plain、text/html と互換性があり、その逆も同様です。事実上、この方法 は対称的であることを除いて includes(org.springframework.http.MediaType) に似ています。

      単に MimeType.isCompatibleWith(MimeType) を呼び出しますが、バイナリの後方互換性のために MediaType パラメーターで宣言されています。

      パラメーター:
      other - 比較する参照メディア型
      戻り値:
      このメディア型が指定されたメディア型と互換性がある場合、true。それ以外の場合は false 

    • copyQualityValue

      public MediaType copyQualityValue(MediaType mediaType)
      指定された MediaType の品質値を持つこのインスタンスのレプリカを返します。
      戻り値:
      指定された MediaType に品質値がない場合は同じインスタンス、そうでない場合は新しいインスタンス

    • removeQualityValue

      public MediaType removeQualityValue()
      品質値を削除して、このインスタンスのレプリカを返します。
      戻り値:
      メディア型に品質値が含まれていない場合は同じインスタンス、そうでない場合は新しい値

    • valueOf

      public static MediaType valueOf(StringSE value)
      指定された文字列値を MediaType オブジェクトに解析します。このメソッド名は、'valueOf' 命名規則に従います ( ConversionService でサポートされている)。
      パラメーター:
      value - 解析する文字列
      例外:
      InvalidMediaTypeException - メディア型の値を解析できない場合
      関連事項:

    • parseMediaType

      public static MediaType parseMediaType(StringSE mediaType)
      指定された文字列を単一の MediaType に解析します。
      パラメーター:
      mediaType - 解析する文字列
      戻り値:
      メディア型
      例外:
      InvalidMediaTypeException - メディア型の値を解析できない場合

    • parseMediaTypes

      public static ListSE<MediaType> parseMediaTypes(@Nullable StringSE mediaTypes)
      コンマ区切りの文字列を解析して、MediaType オブジェクトのリストにします。

      このメソッドを使用して、Accept または Content-Type ヘッダーを解析できます。

      パラメーター:
      mediaTypes - 解析する文字列
      戻り値:
      メディア型のリスト
      例外:
      InvalidMediaTypeException - メディア型の値を解析できない場合

    • parseMediaTypes

      public static ListSE<MediaType> parseMediaTypes(@Nullable ListSE<StringSE> mediaTypes)
      （潜在的に）コンマで区切られた文字列の指定されたリストを、MediaType オブジェクトのリストに解析します。

      このメソッドを使用して、Accept または Content-Type ヘッダーを解析できます。

      パラメーター:
      mediaTypes - 解析する文字列
      戻り値:
      メディア型のリスト
      例外:
      InvalidMediaTypeException - メディア型の値を解析できない場合
      導入:
      4.3.2

    • asMediaTypes

      public static ListSE<MediaType> asMediaTypes(ListSE<MimeType> mimeTypes)
      指定された MIME 型をメディア型として再作成します。
      導入:
      5.0

    • asMediaType

      public static MediaType asMediaType(MimeType mimeType)
      指定された MIME 型をメディア型として再作成します。
      導入:
      5.0

    • toString

      public static StringSE toString(CollectionSE<MediaType> mediaTypes)
      指定された MediaType オブジェクトのリストの文字列表現を返します。

      このメソッドは、Accept または Content-Type ヘッダーに使用できます。

      パラメーター:
      mediaTypes - 文字列表現を作成するメディア型
      戻り値:
      文字列表現

    • sortBySpecificity

      @DeprecatedSE(since="6.0", forRemoval=true) public static void sortBySpecificity(ListSE<MediaType> mediaTypes)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      6.0 の時点で、MimeTypeUtils.sortBySpecificity(List) を推奨
      MediaType オブジェクトの指定されたリストを特異性でソートします。

      次の 2 つのメディア型があるとします。

      1. いずれかのメディア型にワイルドカード型がある場合、ワイルドカードのないメディア型が他のメディア型の前に順序付けられます。
      2. 2 つのメディア型が異なるがあれば種類を、それらは同等とみなされ、それらの現在の順序のままされています。
      3. いずれかのメディア型にワイルドカードサブ型がある場合、ワイルドカードのないメディア型は他のメディア型の前にソートされます。
      4. 2 つのメディア型のサブ型が異なる場合、等しいと見なされ、現在の順序のままになります。
      5. 2 つのメディア型の品質値が異なる場合、最高の品質値を持つメディア型が他のメディア型の前に並べられます。
      6. 2 つのメディア型のパラメーターの量が異なる場合、パラメーターが最も多いメディア型が他のメディア型の前に並べられます。

      例:

      audio/basic < audio/* < */*
      audio/* < audio/*;q=0.7; audio/*;q=0.3
      audio/basic;level=1 < audio/basic
      audio/basic == text/html
      audio/basic == audio/wave
      パラメーター:
      mediaTypes - ソートされるメディア型のリスト

    • sortByQualityValue

      @DeprecatedSE(since="6.0", forRemoval=true) public static void sortByQualityValue(ListSE<MediaType> mediaTypes)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      6.0 の時点で、直接の代替はありません
      MediaType オブジェクトの指定されたリストを品質値でソートします。

      次の 2 つのメディア型があるとします。

      1. 2 つのメディア型の品質値が異なる場合、最高の品質値を持つメディア型が他のメディア型の前に並べられます。
      2. いずれかのメディア型にワイルドカード型がある場合、ワイルドカードのないメディア型が他のメディア型の前に順序付けられます。
      3. 2 つのメディア型が異なるがあれば種類を、それらは同等とみなされ、それらの現在の順序のままされています。
      4. いずれかのメディア型にワイルドカードサブ型がある場合、ワイルドカードのないメディア型は他のメディア型の前にソートされます。
      5. 2 つのメディア型のサブ型が異なる場合、等しいと見なされ、現在の順序のままになります。
      6. 2 つのメディア型のパラメーターの量が異なる場合、パラメーターが最も多いメディア型が他のメディア型の前に並べられます。
      パラメーター:
      mediaTypes - ソートされるメディア型のリスト
      関連事項:

    • sortBySpecificityAndQuality

      @DeprecatedSE(since="6.0") public static void sortBySpecificityAndQuality(ListSE<MediaType> mediaTypes)
      使用すべきではありません。
      6.0 の時点で、MimeTypeUtils.sortBySpecificity(List) を推奨
      指定された MediaType オブジェクトのリストを、一次条件としての特異性および二次条件としての品質値でソートします。