io.vertx.ext.web.ParsedHeaderValue Maven / Gradle / Ivy
package io.vertx.ext.web;
import java.util.Collection;
import java.util.Map;
import io.vertx.codegen.annotations.GenIgnore;
import io.vertx.codegen.annotations.Nullable;
import io.vertx.codegen.annotations.VertxGen;
@VertxGen(concrete = false)
public interface ParsedHeaderValue {
/**
* If no "q" parameter is present, the default weight is 1.
*/
float DEFAULT_WEIGHT = 1;
/**
* Contains the raw value that was received from the user agent
*/
String rawValue();
/**
* Holds the unparsed value of the header.
* For the most part, this is the content before the semi-colon (";")
*/
String value();
/**
* Holds the weight specified in the "q" parameter of the header.
* If the parameter is not specified, 1.0 is assumed according to
* rfc7231
* @return
*/
float weight();
/**
* The value of the parameter specified by this key. Each is one of 3 things:
*
* - null <- That key was not specified
* - ParsedHeaderValue.EMPTY (tested using ==) <- The value was not specified
* - [Other] <- The value of the parameter
*
* Note: The q parameter is never present.
* @return
*/
@Nullable
String parameter(String key);
/**
* The parameters specified in this header value.
* Note: The q parameter is never present.
* @see {@link #parameter(String)}
* @return Unmodifiable Map of parameters of this header value
*/
Map parameters();
/**
* Is this an allowed operation as specified by the corresponding header?
* @return
*/
boolean isPermitted();
/**
* Test if this header is matched by matchTry header
* @param matchTry The header to be matched from
* @return true if this header represents a subset of matchTry, otherwise, false
*/
boolean isMatchedBy(ParsedHeaderValue matchTry);
/**
* 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.
*
* @param matchTries A list of parsed headers to match from this header value
* @return Optional potentially with the first matched header
*/
@GenIgnore
T findMatchedBy(Collection matchTries);
/**
* An integer that represents the absolute order position of this header
*/
int weightedOrder();
}