クラス ProducesRequestCondition
java.lang.ObjectSE
org.springframework.web.servlet.mvc.condition.AbstractRequestCondition<ProducesRequestCondition>
org.springframework.web.servlet.mvc.condition.ProducesRequestCondition
- 実装されたすべてのインターフェース:
RequestCondition<ProducesRequestCondition>
public final class ProducesRequestCondition
extends AbstractRequestCondition<ProducesRequestCondition>
リクエストの "Accept" ヘッダーをメディア型式のリストに一致させる論理和('| |')リクエスト条件。2 種類のメディア型式がサポートされています。これらは、ヘッダー名が "Accept" である
RequestMapping.produces()
および RequestMapping.headers()
で説明されています。使用する構文に関係なく、セマンティクスは同じです。- 導入:
- 3.1
- 作成者:
- Arjen Poutsma, Rossen Stoyanchev
コンストラクターのサマリー
コンストラクター説明ProducesRequestCondition
(StringSE... produces) 「プロデュース」式から新しいインスタンスを作成します。ProducesRequestCondition
(StringSE[] produces, StringSE[] headers) "produces" および "header" 式を使用して新しいインスタンスを作成します。ProducesRequestCondition
(StringSE[] produces, StringSE[] headers, ContentNegotiationManager manager) メソッドのサマリー
修飾子と型メソッド説明static void
これを使用して、解析され、リクエストされたメディア型を含むMEDIA_TYPES_ATTRIBUTE
をクリアします。combine
(ProducesRequestCondition other) 式がある場合、「その他」のインスタンスを返します。それ以外の場合は "this" インスタンスを返します。int
compareTo
(ProducesRequestCondition other, HttpServletRequestEE request) これと別の「生成」条件を次のように比較します。MimeTypeUtils.sortBySpecificity(List)
を介して品質値で "Accept" ヘッダーメディア型をソートし、リストを反復します。protected ListSE<org.springframework.web.servlet.mvc.condition.ProducesRequestCondition.ProduceMediaTypeExpression>
リクエスト条件を構成する個別のアイテムを返します。含まれている「プロデュース」式を返します。getMatchingCondition
(HttpServletRequestEE request) 含まれているメディア型式のいずれかが指定されたリクエストの "Content-Type" ヘッダーと一致するかどうかを確認し、一致する式のみが含まれていることが保証されているインスタンスを返します。否定表現を除く、含まれている作成可能なメディア型を返します。protected StringSE
コンテンツの個別のアイテムを出力するときに使用する表記。boolean
isEmpty()
条件にメディア型式があるかどうか。クラス org.springframework.web.servlet.mvc.condition.AbstractRequestCondition から継承されたメソッド
equals, hashCode, toString
コンストラクターの詳細
ProducesRequestCondition
「プロデュース」式から新しいインスタンスを作成します。合計 0 個の式が指定されている場合、この条件はすべてのリクエストに一致します。- パラメーター:
produces
-RequestMapping.produces()
で定義された構文の式
ProducesRequestCondition
"produces" および "header" 式を使用して新しいインスタンスを作成します。ヘッダー名が "Accept" でない、またはヘッダー値が定義されていない "Header" 式は無視されます。合計 0 個の式が指定されている場合、この条件はすべてのリクエストに一致します。- パラメーター:
produces
-RequestMapping.produces()
で定義された構文の式headers
-RequestMapping.headers()
で定義された構文の式
ProducesRequestCondition
public ProducesRequestCondition(@Nullable StringSE[] produces, @Nullable StringSE[] headers, @Nullable ContentNegotiationManager manager) - パラメーター:
produces
-RequestMapping.produces()
で定義された構文の式headers
-RequestMapping.headers()
で定義された構文の式manager
- リクエストされたメディア型を決定するために使用されます
メソッドの詳細
getExpressions
含まれている「プロデュース」式を返します。getProducibleMediaTypes
否定表現を除く、含まれている作成可能なメディア型を返します。isEmpty
public boolean isEmpty()条件にメディア型式があるかどうか。- オーバーライド:
- クラス
AbstractRequestCondition<ProducesRequestCondition>
のisEmpty
- 戻り値:
- 空の場合は
true
。それ以外の場合はfalse
getContent
protected ListSE<org.springframework.web.servlet.mvc.condition.ProducesRequestCondition.ProduceMediaTypeExpression> getContent()クラスからコピーされた説明:AbstractRequestCondition
リクエスト条件を構成する個別のアイテムを返します。たとえば、URL パターン、HTTP リクエストメソッド、パラメーター式など。
- 次で指定:
- クラス
AbstractRequestCondition<ProducesRequestCondition>
のgetContent
- 戻り値:
- オブジェクトのコレクション (非
null
)
getToStringInfix
クラスからコピーされた説明:AbstractRequestCondition
コンテンツの個別のアイテムを出力するときに使用する表記。たとえば、URL パターンの
" || "
または param 式の" && "
。combine
式がある場合は、「その他」のインスタンスを返します。それ以外の場合は "this" インスタンスを返します。実際には、これは、メソッドレベルの「プロデュース」が型レベルの「プロデュース」条件をオーバーライドすることを意味します。- パラメーター:
other
- 組み合わせる条件。- 戻り値:
- 2 つの条件インスタンスを組み合わせた結果であるリクエスト条件インスタンス。
getMatchingCondition
含まれているメディア型式のいずれかが指定されたリクエストの "Content-Type" ヘッダーと一致するかどうかを確認し、一致する式のみが含まれていることが保証されているインスタンスを返します。一致はMediaType.isCompatibleWith(MediaType)
を介して実行されます。- パラメーター:
request
- 現在のリクエスト- 戻り値:
- 式がない場合は同じインスタンス。または、式が一致する新しい条件。一致する式がない場合は
null
。
compareTo
これと別の「生成」条件を次のように比較します。- 'Accept' ヘッダーメディア型を
MimeTypeUtils.sortBySpecificity(List)
を介して品質値で並べ替え、リストを繰り返します。 - 最初に
MimeType.equals(Object)
と一致し、次にMediaType.includes(MediaType)
と一致する、各「生成」条件で一致するメディア型の最初のインデックスを取得します。 - より低いインデックスが見つかった場合、そのインデックスの条件が優先されます。
- 両方のインデックスが等しい場合、インデックスのメディア型は
MediaType.isMoreSpecific(MimeType)
とさらに比較されます。
両方のインスタンスが
getMatchingCondition(HttpServletRequest)
を介して取得されており、各インスタンスに一致する生成可能なメディア型式のみが含まれているか、そうでない場合は空であると想定されます。- 'Accept' ヘッダーメディア型を
clearMediaTypesAttribute
これを使用して、解析され、リクエストされたメディア型を含むMEDIA_TYPES_ATTRIBUTE
をクリアします。- パラメーター:
request
- 現在のリクエスト- 導入:
- 5.2