vertx / io.vertx.ext.web / ParsedHeaderValue

ParsedHeaderValue

interface ParsedHeaderValue

Properties

DEFAULT_WEIGHT

static val DEFAULT_WEIGHT: Float

If no "q" parameter is present, the default weight is 1.

Functions

findMatchedBy

abstract fun <T : ParsedHeaderValue> findMatchedBy(matchTries: MutableCollection<T>): T

Finds the first ParsedHeaderValue in the list that matches with this header value. Will return an empty Optional if none match. This method is intended for internal usage.

isMatchedBy

abstract fun isMatchedBy(matchTry: ParsedHeaderValue): Boolean

Test if this header is matched by matchTry header

isPermitted

abstract fun isPermitted(): Boolean

Is this an allowed operation as specified by the corresponding header?

parameter

abstract fun parameter(key: String): String

The value of the parameter specified by this key. Each is one of 3 things:

  1. null <- That key was not specified
  2. ParsedHeaderValue.EMPTY (tested using ==) <- The value was not specified
  3. [Other] <- The value of the parameter
Note: The q parameter is never present.

parameters

abstract fun parameters(): MutableMap<String, String>

The parameters specified in this header value. Note: The q parameter is never present.

rawValue

abstract fun rawValue(): String

Contains the raw value that was received from the user agent

value

abstract fun value(): String

Holds the unparsed value of the header. For the most part, this is the content before the semi-colon (";")

weight

abstract fun weight(): Float

Holds the weight specified in the "q" parameter of the header. If the parameter is not specified, 1.0 is assumed according to rfc7231

weightedOrder

abstract fun weightedOrder(): Int

An integer that represents the absolute order position of this header