Spring Framework 6.1.4 · org.springframework.web.servlet.mvc.condition.ProducesRequestCondition

Modifier and Type	Class and Description
pack-priv static class	ProducesRequestCondition.ProduceMediaTypeExpression Parses and matches a single media type expression to a request's 'Accept' header.

Modifier and Type	Field and Description
private final ContentNegotiationManager	contentNegotiationManager
private static final ContentNegotiationManager	DEFAULT_CONTENT_NEGOTIATION_MANAGER
private static final ProducesRequestCondition	EMPTY_CONDITION
private final List<ProducesRequestCondition.ProduceMediaTypeExpression>	expressions
private static final List<ProducesRequestCondition.ProduceMediaTypeExpression>	MEDIA_TYPE_ALL_LIST
private static final String	MEDIA_TYPES_ATTRIBUTE

Constructor Summary

Access	Constructor and Description
public	ProducesRequestCondition(String... expressions with syntax defined by `RequestMapping#produces()` produces) Creates a new instance from "produces" expressions.
public	ProducesRequestCondition(String[] expressions with syntax defined by `RequestMapping#produces()` produces, String[] expressions with syntax defined by `RequestMapping#headers()` headers) Creates a new instance with "produces" and "header" expressions.
public	ProducesRequestCondition(String[] expressions with syntax defined by `RequestMapping#produces()` produces, String[] expressions with syntax defined by `RequestMapping#headers()` headers, ContentNegotiationManager used to determine requested media types manager) Same as `ProducesRequestCondition(String[], String[])` but also accepting a `ContentNegotiationManager`.
private	ProducesRequestCondition(List<ProducesRequestCondition.ProduceMediaTypeExpression> expressions, ProducesRequestCondition other) Private constructor for internal use to create matching conditions.

Method Summary

Modifier and Type	Method and Description
public static void	clearMediaTypesAttribute(HttpServletRequest the current request request) Use this to clear `MEDIA_TYPES_ATTRIBUTE` that contains the parsed, requested media types.
public ProducesRequestCondition	combine(ProducesRequestCondition the condition to combine with. other) Implements org.springframework.web.servlet.mvc.condition.RequestCondition.combine. Returns the "other" instance if it has any expressions; returns "this" instance otherwise.
private int	compareMatchingMediaTypes(ProducesRequestCondition condition1, int index1, ProducesRequestCondition condition2, int index2)
public int	compareTo(ProducesRequestCondition other, HttpServletRequest request) Implements org.springframework.web.servlet.mvc.condition.RequestCondition.compareTo. Compares this and another "produces" condition as follows: Sort 'Accept' header media types by quality value via `org.springframework.util.MimeTypeUtils#sortBySpecificity(List)` and iterate the list. Get the first index of matching media types in each "produces" condition first matching with `MediaType#equals(Object)` and then with `MediaType#includes(MediaType)`. If a lower index is found, the condition at that index wins. If both indexes are equal, the media types at the index are compared further with `MediaType#isMoreSpecific(MimeType)`.
private List<MediaType>	getAcceptedMediaTypes(HttpServletRequest request)
protected List<ProducesRequestCondition.ProduceMediaTypeExpression>	getContent() Implements abstract org.springframework.web.servlet.mvc.condition.AbstractRequestCondition.getContent. Return the discrete items a request condition is composed of.
public Set<MediaTypeExpression>	getExpressions() Return the contained "produces" expressions.
private List<ProducesRequestCondition.ProduceMediaTypeExpression>	getExpressionsToCompare() Return the contained "produces" expressions or if that's empty, a list with a / expression.
public ProducesRequestCondition	Returns: the same instance if there are no expressions; or a new condition with matching expressions; or `null` if no expressions match. getMatchingCondition(HttpServletRequest the current request request) Implements org.springframework.web.servlet.mvc.condition.RequestCondition.getMatchingCondition. 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<ProducesRequestCondition.ProduceMediaTypeExpression>	getMatchingExpressions(List<MediaType> acceptedMediaTypes)
public Set<MediaType>	getProducibleMediaTypes() Return the contained producible media types excluding negated expressions.
protected String	getToStringInfix() Implements abstract org.springframework.web.servlet.mvc.condition.AbstractRequestCondition.getToStringInfix. The notation to use when printing discrete items of content.
private int	indexOfEqualMediaType(MediaType mediaType)
private int	indexOfIncludedMediaType(MediaType mediaType)
public boolean	isEmpty() Overrides org.springframework.web.servlet.mvc.condition.AbstractRequestCondition.isEmpty. Whether the condition has any media type expressions.
private List<ProducesRequestCondition.ProduceMediaTypeExpression>	parseExpressions(String[] produces, String[] headers)

Inherited from org.springframework.web.servlet.mvc.condition.AbstractRequestCondition:: equals hashCode toString

Field Detail

contentNegotiationManager	back to summary
private final ContentNegotiationManager contentNegotiationManager

DEFAULT_CONTENT_NEGOTIATION_MANAGER	back to summary
private static final ContentNegotiationManager DEFAULT_CONTENT_NEGOTIATION_MANAGER

EMPTY_CONDITION	back to summary
private static final ProducesRequestCondition EMPTY_CONDITION

expressions	back to summary
private final List<ProducesRequestCondition.ProduceMediaTypeExpression> expressions

MEDIA_TYPE_ALL_LIST	back to summary
private static final List<ProducesRequestCondition.ProduceMediaTypeExpression> MEDIA_TYPE_ALL_LIST

MEDIA_TYPES_ATTRIBUTE	back to summary
private static final String MEDIA_TYPES_ATTRIBUTE

Constructor Detail

ProducesRequestCondition back to summary

ProducesRequestCondition	back to summary
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. Parameters produces:String[] expressions with syntax defined by `RequestMapping#produces()`

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.

Parameters

produces:String[]: expressions with syntax defined by RequestMapping#produces()

ProducesRequestCondition back to summary

ProducesRequestCondition	back to summary
public ProducesRequestCondition(String[] produces, 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. Parameters produces:String[] expressions with syntax defined by `RequestMapping#produces()` headers:String[] expressions with syntax defined by `RequestMapping#headers()`

public ProducesRequestCondition(String[] produces, 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.

Parameters

produces:String[]: expressions with syntax defined by RequestMapping#produces()
headers:String[]: expressions with syntax defined by RequestMapping#headers()

ProducesRequestCondition back to summary

ProducesRequestCondition	back to summary
public ProducesRequestCondition(String[] produces, String[] headers, ContentNegotiationManager manager) Same as `ProducesRequestCondition(String[], String[])` but also accepting a `ContentNegotiationManager`. Parameters produces:String[] expressions with syntax defined by `RequestMapping#produces()` headers:String[] expressions with syntax defined by `RequestMapping#headers()` manager:ContentNegotiationManager used to determine requested media types

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

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

Parameters

produces:String[]: expressions with syntax defined by RequestMapping#produces()
headers:String[]: expressions with syntax defined by RequestMapping#headers()
manager:ContentNegotiationManager: used to determine requested media types

ProducesRequestCondition	back to summary
private ProducesRequestCondition(List<ProducesRequestCondition.ProduceMediaTypeExpression> expressions, ProducesRequestCondition other) Private constructor for internal use to create matching conditions. Note the expressions List is neither sorted nor deep copied.

Method Detail

clearMediaTypesAttribute back to summary

clearMediaTypesAttribute	back to summary
public static void clearMediaTypesAttribute(HttpServletRequest request) Use this to clear `MEDIA_TYPES_ATTRIBUTE` that contains the parsed, requested media types. Parameters request:HttpServletRequest the current request Since 5.2

public static void clearMediaTypesAttribute(HttpServletRequest request)

Use this to clear MEDIA_TYPES_ATTRIBUTE that contains the parsed, requested media types.

Parameters

request:HttpServletRequest: the current request

Since

5.2

combine	back to summary
public ProducesRequestCondition combine(ProducesRequestCondition other) Implements org.springframework.web.servlet.mvc.condition.RequestCondition.combine. 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. Parameters other:ProducesRequestCondition Doc from org.springframework.web.servlet.mvc.condition.RequestCondition.combine. the condition to combine with. Returns:ProducesRequestCondition Doc from org.springframework.web.servlet.mvc.condition.RequestCondition.combine. a request condition instance that is the result of combining the two condition instances. Annotations @Override

combine

back to summary

public ProducesRequestCondition combine(ProducesRequestCondition other)

Implements org.springframework.web.servlet.mvc.condition.RequestCondition.combine.

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.

Parameters

other:ProducesRequestCondition

Doc from org.springframework.web.servlet.mvc.condition.RequestCondition.combine.

the condition to combine with.

Returns:ProducesRequestCondition

Doc from org.springframework.web.servlet.mvc.condition.RequestCondition.combine.

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

Annotations

@Override

compareMatchingMediaTypes	back to summary
private int compareMatchingMediaTypes(ProducesRequestCondition condition1, int index1, ProducesRequestCondition condition2, int index2)

compareTo back to summary

compareTo	back to summary
public int compareTo(ProducesRequestCondition other, HttpServletRequest request) Implements org.springframework.web.servlet.mvc.condition.RequestCondition.compareTo. Compares this and another "produces" condition as follows: Sort 'Accept' header media types by quality value via `org.springframework.util.MimeTypeUtils#sortBySpecificity(List)` and iterate the list. Get the first index of matching media types in each "produces" condition first matching with `MediaType#equals(Object)` and then with `MediaType#includes(MediaType)`. If a lower index is found, the condition at that index wins. 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(HttpServletRequest)` and each instance contains the matching producible media type expression only or is otherwise empty. Annotations @Override

public int compareTo(ProducesRequestCondition other, HttpServletRequest request)

Implements org.springframework.web.servlet.mvc.condition.RequestCondition.compareTo.

Compares this and another "produces" condition as follows:

Sort 'Accept' header media types by quality value via org.springframework.util.MimeTypeUtils#sortBySpecificity(List) and iterate the list.
Get the first index of matching media types in each "produces" condition first matching with MediaType#equals(Object) and then with MediaType#includes(MediaType).
If a lower index is found, the condition at that index wins.
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(HttpServletRequest) and each instance contains the matching producible media type expression only or is otherwise empty.

Annotations

@Override

getAcceptedMediaTypes	back to summary
private List<MediaType> getAcceptedMediaTypes(HttpServletRequest request) throws HttpMediaTypeNotAcceptableException Annotations @SuppressWarnings:unchecked

getContent back to summary

getContent	back to summary
protected List<ProducesRequestCondition.ProduceMediaTypeExpression> getContent() Implements abstract org.springframework.web.servlet.mvc.condition.AbstractRequestCondition.getContent. Doc from org.springframework.web.servlet.mvc.condition.AbstractRequestCondition.getContent. Return the discrete items a request condition is composed of. For example URL patterns, HTTP request methods, param expressions, etc. Returns:List<ProducesRequestCondition.ProduceMediaTypeExpression> a collection of objects (never `null`) Annotations @Override

protected List<ProducesRequestCondition.ProduceMediaTypeExpression> getContent()

Implements abstract org.springframework.web.servlet.mvc.condition.AbstractRequestCondition.getContent.

Doc from org.springframework.web.servlet.mvc.condition.AbstractRequestCondition.getContent.

Return the discrete items a request condition is composed of.

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

Returns:List<ProducesRequestCondition.ProduceMediaTypeExpression>

a collection of objects (never null)

Annotations

@Override

getExpressions	back to summary
public Set<MediaTypeExpression> getExpressions() Return the contained "produces" expressions.

getExpressionsToCompare	back to summary
private List<ProducesRequestCondition.ProduceMediaTypeExpression> getExpressionsToCompare() Return the contained "produces" expressions or if that's empty, a list with a / expression.

getMatchingCondition back to summary

getMatchingCondition	back to summary
public ProducesRequestCondition getMatchingCondition(HttpServletRequest request) Implements org.springframework.web.servlet.mvc.condition.RequestCondition.getMatchingCondition. 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)`. Parameters request:HttpServletRequest the current request Returns:ProducesRequestCondition the same instance if there are no expressions; or a new condition with matching expressions; or `null` if no expressions match. Annotations @Override @Nullable

public ProducesRequestCondition getMatchingCondition(HttpServletRequest request)

Implements org.springframework.web.servlet.mvc.condition.RequestCondition.getMatchingCondition.

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).

Parameters

request:HttpServletRequest: the current request

Returns:ProducesRequestCondition

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

Annotations

@Override
@Nullable

getMatchingExpressions	back to summary
private List<ProducesRequestCondition.ProduceMediaTypeExpression> getMatchingExpressions(List<MediaType> acceptedMediaTypes) Annotations @Nullable

getProducibleMediaTypes	back to summary
public Set<MediaType> getProducibleMediaTypes() Return the contained producible media types excluding negated expressions.

getToStringInfix back to summary

getToStringInfix	back to summary
protected String getToStringInfix() Implements abstract org.springframework.web.servlet.mvc.condition.AbstractRequestCondition.getToStringInfix. Doc from org.springframework.web.servlet.mvc.condition.AbstractRequestCondition.getToStringInfix. The notation to use when printing discrete items of content. For example `" \|\| "` for URL patterns or `" && "` for param expressions. Annotations @Override

protected String getToStringInfix()

Implements abstract org.springframework.web.servlet.mvc.condition.AbstractRequestCondition.getToStringInfix.

Doc from org.springframework.web.servlet.mvc.condition.AbstractRequestCondition.getToStringInfix.

The notation to use when printing discrete items of content.

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

Annotations

@Override

indexOfEqualMediaType	back to summary
private int indexOfEqualMediaType(MediaType mediaType)

indexOfIncludedMediaType	back to summary
private int indexOfIncludedMediaType(MediaType mediaType)

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Overrides org.springframework.web.servlet.mvc.condition.AbstractRequestCondition.isEmpty. Whether the condition has any media type expressions. Returns:boolean Doc from org.springframework.web.servlet.mvc.condition.AbstractRequestCondition.isEmpty. `true` if empty; `false` otherwise Annotations @Override

public boolean isEmpty()

Overrides org.springframework.web.servlet.mvc.condition.AbstractRequestCondition.isEmpty.

Whether the condition has any media type expressions.

Returns:boolean

Doc from org.springframework.web.servlet.mvc.condition.AbstractRequestCondition.isEmpty.

true if empty; false otherwise

Annotations

@Override

parseExpressions	back to summary
private List<ProducesRequestCondition.ProduceMediaTypeExpression> parseExpressions(String[] produces, String[] headers)

Modifier and Type	Method and Description
public final boolean	match(List<MediaType> acceptedMediaTypes)
private boolean	matchMediaType(List<MediaType> acceptedMediaTypes)

public final Class ProducesRequestCondition

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class ProducesRequestCondition.ProduceMediaTypeExpression

Constructor Summary

Method Summary

Constructor Detail

Method Detail

Access	Constructor and Description
pack-priv	ProduceMediaTypeExpression(MediaType mediaType, boolean negated)
pack-priv	ProduceMediaTypeExpression(String expression)