程序包 cn.taketoday.web.handler.condition

类 ProducesRequestCondition

java.lang.Object

cn.taketoday.web.handler.condition.AbstractRequestCondition<ProducesRequestCondition>

cn.taketoday.web.handler.condition.ProducesRequestCondition

所有已实现的接口:

RequestCondition<ProducesRequestCondition>

public final class ProducesRequestCondition
extends AbstractRequestCondition<ProducesRequestCondition>

A logical disjunction (' || ') request condition to match a request's 'Accept' header to a list of media type expressions. Two kinds of media type expressions are supported, which are described in RequestMapping.produces() and RequestMapping.headers() where the header name is 'Accept'. Regardless of which syntax is used, the semantics are the same.

从以下版本开始:

4.0

作者:

Arjen Poutsma, Rossen Stoyanchev, Harry Yang

字段概要

字段

修饰符和类型	字段	说明
private final ContentNegotiationManager	contentNegotiationManager
private static final ContentNegotiationManager	DEFAULT_CONTENT_NEGOTIATION_MANAGER
private static final ProducesRequestCondition	EMPTY_CONDITION
private final List<MediaTypeExpression>	expressions
private static final List<MediaTypeExpression>	MEDIA_TYPE_ALL_LIST
private static final String	MEDIA_TYPES_ATTRIBUTE

构造器概要

构造器

限定符	构造器	说明
	ProducesRequestCondition(String... produces)	Creates a new instance from "produces" expressions.
	ProducesRequestCondition(String[] produces, String[] headers)	Creates a new instance with "produces" and "header" expressions.
	ProducesRequestCondition(String[] produces, String[] headers, ContentNegotiationManager manager)	Same as ProducesRequestCondition(String[], String[]) but also accepting a ContentNegotiationManager.
private	ProducesRequestCondition(List<MediaTypeExpression> expressions, ProducesRequestCondition other)	Private constructor for internal use to create matching conditions.

方法概要

修饰符和类型	方法	说明
ProducesRequestCondition	combine(ProducesRequestCondition other)	Returns the "other" instance if it has any expressions; returns "this" instance otherwise.
private int	compareMatchingMediaTypes(ProducesRequestCondition condition1, int index1, ProducesRequestCondition condition2, int index2)
int	compareTo(ProducesRequestCondition other, RequestContext request)	Compares this and another "produces" condition as follows: Sort 'Accept' header media types by quality value via MimeTypeUtils.sortBySpecificity(List) and iterate the list.
private List<MediaType>	getAcceptedMediaTypes(RequestContext request)
protected List<MediaTypeExpression>	getContent()	Return the discrete items a request condition is composed of.
Set<MediaTypeExpression>	getExpressions()	Return the contained "produces" expressions.
private List<MediaTypeExpression>	getExpressionsToCompare()	Return the contained "produces" expressions or if that's empty, a list with a "*/*" expression.
ProducesRequestCondition	getMatchingCondition(RequestContext request)	Checks if any of the contained media type expressions match the given request 'Content-Type' header and returns an instance that is guaranteed to contain matching expressions only.
private List<MediaTypeExpression>	getMatchingExpressions(List<MediaType> acceptedMediaTypes)
Set<MediaType>	getProducibleMediaTypes()	Return the contained producible media types excluding negated expressions.
protected String	getToStringInfix()	The notation to use when printing discrete items of content.
private int	indexOfEqualMediaType(MediaType mediaType)
private int	indexOfIncludedMediaType(MediaType mediaType)
boolean	isEmpty()	Whether the condition has any media type expressions.

从类继承的方法 cn.taketoday.web.handler.condition.AbstractRequestCondition

equals, hashCode, toString

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

字段详细资料

MEDIA_TYPES_ATTRIBUTE

private static final String MEDIA_TYPES_ATTRIBUTE

DEFAULT_CONTENT_NEGOTIATION_MANAGER

private static final ContentNegotiationManager DEFAULT_CONTENT_NEGOTIATION_MANAGER

EMPTY_CONDITION

private static final ProducesRequestCondition EMPTY_CONDITION

MEDIA_TYPE_ALL_LIST

private static final List<MediaTypeExpression> MEDIA_TYPE_ALL_LIST

expressions

private final List<MediaTypeExpression> expressions

contentNegotiationManager

private final ContentNegotiationManager contentNegotiationManager

构造器详细资料

ProducesRequestCondition

public ProducesRequestCondition(String... produces)

Creates a new instance from "produces" expressions. If 0 expressions are provided in total, this condition will match to any request.

参数:

produces - expressions with syntax defined by RequestMapping.produces()

ProducesRequestCondition

public ProducesRequestCondition(String[] produces,
 @Nullable
 String[] headers)

Creates a new instance with "produces" and "header" expressions. "Header" expressions where the header name is not 'Accept' or have no header value defined are ignored. If 0 expressions are provided in total, this condition will match to any request.

参数:

produces - expressions with syntax defined by RequestMapping.produces()

headers - expressions with syntax defined by RequestMapping.headers()

ProducesRequestCondition

public ProducesRequestCondition(String[] produces,
 @Nullable
 String[] headers,
 @Nullable
 ContentNegotiationManager manager)

Same as ProducesRequestCondition(String[], String[]) but also accepting a ContentNegotiationManager.

参数:

produces - expressions with syntax defined by RequestMapping.produces()

headers - expressions with syntax defined by RequestMapping.headers()

manager - used to determine requested media types

ProducesRequestCondition

private ProducesRequestCondition(List<MediaTypeExpression> expressions,
 ProducesRequestCondition other)

Private constructor for internal use to create matching conditions. Note the expressions List is neither sorted nor deep copied.

方法详细资料

getExpressions

public Set<MediaTypeExpression> getExpressions()

Return the contained "produces" expressions.

getProducibleMediaTypes

public Set<MediaType> getProducibleMediaTypes()

Return the contained producible media types excluding negated expressions.

isEmpty

public boolean isEmpty()

Whether the condition has any media type expressions.

覆盖:

isEmpty 在类中 AbstractRequestCondition<ProducesRequestCondition>

返回:

true if empty; false otherwise

getContent

protected List<MediaTypeExpression> getContent()

从类复制的说明: AbstractRequestCondition

Return the discrete items a request condition is composed of.

For example URL patterns, HTTP request methods, param expressions, etc.

指定者:

getContent 在类中 AbstractRequestCondition<ProducesRequestCondition>

返回:

a collection of objects (never null)

getToStringInfix

protected String getToStringInfix()

从类复制的说明: AbstractRequestCondition

The notation to use when printing discrete items of content.

For example " || " for URL patterns or " && " for param expressions.

指定者:

getToStringInfix 在类中 AbstractRequestCondition<ProducesRequestCondition>

combine

public ProducesRequestCondition combine(ProducesRequestCondition other)

Returns the "other" instance if it has any expressions; returns "this" instance otherwise. Practically that means a method-level "produces" overrides a type-level "produces" condition.

参数:

other - the condition to combine with.

返回:

a request condition instance that is the result of combining the two condition instances.

getMatchingCondition

@Nullable
public ProducesRequestCondition getMatchingCondition(RequestContext request)

Checks if any of the contained media type expressions match the given request 'Content-Type' header and returns an instance that is guaranteed to contain matching expressions only. The match is performed via MediaType.isCompatibleWith(MediaType).

参数:

request - the current request

返回:

the same instance if there are no expressions; or a new condition with matching expressions; or null if no expressions match.

getMatchingExpressions

@Nullable
private List<MediaTypeExpression> getMatchingExpressions(List<MediaType> acceptedMediaTypes)

compareTo

public int compareTo(ProducesRequestCondition other,
 RequestContext request)

Compares this and another "produces" condition as follows:

1. Sort 'Accept' header media types by quality value via MimeTypeUtils.sortBySpecificity(List) and iterate the list.
2. Get the first index of matching media types in each "produces" condition first matching with MimeType.equals(Object) and then with MediaType.includes(MediaType).
3. If a lower index is found, the condition at that index wins.
4. If both indexes are equal, the media types at the index are compared further with MediaType.isMoreSpecific(MimeType).

It is assumed that both instances have been obtained via getMatchingCondition(RequestContext) and each instance contains the matching producible media type expression only or is otherwise empty.

request - the current request context

getAcceptedMediaTypes

private List<MediaType> getAcceptedMediaTypes(RequestContext request)
                                       throws HttpMediaTypeNotAcceptableException

抛出:

HttpMediaTypeNotAcceptableException

indexOfEqualMediaType

private int indexOfEqualMediaType(MediaType mediaType)

indexOfIncludedMediaType

private int indexOfIncludedMediaType(MediaType mediaType)

compareMatchingMediaTypes

private int compareMatchingMediaTypes(ProducesRequestCondition condition1,
 int index1,
 ProducesRequestCondition condition2,
 int index2)

getExpressionsToCompare

private List<MediaTypeExpression> getExpressionsToCompare()

Return the contained "produces" expressions or if that's empty, a list with a "*/*" expression.