类 ConsumesRequestCondition

构造器详细资料

• ConsumesRequestCondition

  public ConsumesRequestCondition​(String... consumes)

  Creates a new instance from 0 or more "consumes" expressions.

  参数:

  consumes - expressions with the syntax described in RequestMapping.consumes(); if 0 expressions are provided, the condition will match to every request

• ConsumesRequestCondition

  public ConsumesRequestCondition​(String[] consumes,
                                  String[] headers)

  Creates a new instance with "consumes" and "header" expressions. "Header" expressions where the header name is not 'Content-Type' or have no header value defined are ignored. If 0 expressions are provided in total, the condition will match to every request

  参数:

  consumes - as described in RequestMapping.consumes()

  headers - as described in RequestMapping.headers()

方法详细资料

• getExpressions

  public Set<MediaTypeExpression> getExpressions()

  Return the contained MediaType expressions.

• getConsumableMediaTypes

  public Set<MediaType> getConsumableMediaTypes()

  Returns the media types for this condition excluding negated expressions.

• isEmpty

  public boolean isEmpty()

  Whether the condition has any media type expressions.

  覆盖:

  isEmpty 在类中 AbstractRequestCondition<ConsumesRequestCondition>

  返回:

  true if empty; false otherwise

• getContent

  protected Collection<org.springframework.web.reactive.result.condition.ConsumesRequestCondition.ConsumeMediaTypeExpression> getContent()

  从类复制的说明: AbstractRequestCondition
  Return the discrete items a request condition is composed of.

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

  指定者:

  getContent 在类中 AbstractRequestCondition<ConsumesRequestCondition>

  返回:

  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<ConsumesRequestCondition>

• setBodyRequired

  public void setBodyRequired​(boolean bodyRequired)

  Whether this condition should expect requests to have a body.

  By default this is set to true in which case it is assumed a request body is required and this condition matches to the "Content-Type" header or falls back on "Content-Type: application/octet-stream".

  If set to false, and the request does not have a body, then this condition matches automatically, i.e. without checking expressions.

  参数:

  bodyRequired - whether requests are expected to have a body

  从以下版本开始:

  5.2

• isBodyRequired

  public boolean isBodyRequired()

  Return the setting for setBodyRequired(boolean).

  从以下版本开始:

  5.2

• combine

  public ConsumesRequestCondition combine​(ConsumesRequestCondition other)

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

  参数:

  other - the condition to combine with.

  返回:

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

• getMatchingCondition

  public ConsumesRequestCondition getMatchingCondition​(ServerWebExchange exchange)

  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.includes(MediaType).

  参数:

  exchange - the current exchange

  返回:

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

• compareTo

  public int compareTo​(ConsumesRequestCondition other,
                       ServerWebExchange exchange)

  Returns:

  • 0 if the two conditions have the same number of expressions
  • Less than 0 if "this" has more or more specific media type expressions
  • Greater than 0 if "other" has more or more specific media type expressions

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