Module org.eclipse.jetty.http

Package org.eclipse.jetty.http

Class HttpField

java.lang.Object

org.eclipse.jetty.http.HttpField

Direct Known Subclasses:

HostPortHttpField, HttpField.IntValueHttpField, HttpField.LongValueHttpField, PreEncodedHttpField

public class HttpField
extends Object

An HTTP Field

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpField.IntValueHttpField
static class	HttpField.LongValueHttpField

Field Summary

Fields

Modifier and Type	Field	Description
static final org.eclipse.jetty.util.QuotedStringTokenizer	NAME_VALUE_TOKENIZER	A constant QuotedStringTokenizer configured for quoting/tokenizing a single parameter as defined by RFC9110
static final org.eclipse.jetty.util.QuotedStringTokenizer	PARAMETER_TOKENIZER	A constant QuotedStringTokenizer configured for quoting/tokenizing parameters lists as defined by RFC9110

Constructor Summary

Constructors

Constructor	Description
HttpField(String name, String value)
HttpField(HttpHeader header, String value)
HttpField(HttpHeader header, String name, String value)
HttpField(HttpHeader header, HttpHeaderValue value)

Method Summary

Modifier and Type	Method	Description
boolean	contains(String search)	Look for a value in a possible multivalued field
static boolean	contains(String value, String search)	Look for a value in a possible multivalued field
boolean	equals(Object o)
HttpHeader	getHeader()
int	getIntValue()
long	getLongValue()
String	getLowerCaseName()
String	getName()
String	getValue()
List<String>	getValueList()
static String	getValueParameters(String valueParams, Map<String,String> parameters)	Get field value parameters.
String[]	getValues()
int	hashCode()
boolean	is(String name)
boolean	isSameName(HttpField field)
static String	stripParameters(String value)	Get field value without parameters.
String	toString()
static String	valueParameters(String value, Map<String,String> parameters)

Methods inherited from class java.lang.Object

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

Field Details

PARAMETER_TOKENIZER

public static final org.eclipse.jetty.util.QuotedStringTokenizer PARAMETER_TOKENIZER

A constant QuotedStringTokenizer configured for quoting/tokenizing parameters lists as defined by RFC9110

NAME_VALUE_TOKENIZER

public static final org.eclipse.jetty.util.QuotedStringTokenizer NAME_VALUE_TOKENIZER

A constant QuotedStringTokenizer configured for quoting/tokenizing a single parameter as defined by RFC9110

Constructor Details

HttpField

public HttpField(HttpHeader header,
 String name,
 String value)

HttpField

public HttpField(HttpHeader header,
 String value)

HttpField

public HttpField(HttpHeader header,
 HttpHeaderValue value)

HttpField

public HttpField(String name,
 String value)

Method Details

getValueParameters

public static String getValueParameters(String valueParams,
 Map<String,String> parameters)

Get field value parameters. Some field values can have parameters. This method separates the value from the parameters and optionally populates a map with the parameters. For example:

 FieldName : Value ; param1=val1 ; param2=val2

 

Parameters:

valueParams - The Field value, possibly with parameters.

parameters - A map to populate with the parameters, or null

Returns:

The value.

stripParameters

public static String stripParameters(String value)

Get field value without parameters. Some field values can have parameters. This method separates the value from the parameters and optionally populates a map with the parameters. For example:

 FieldName : Value ; param1=val1 ; param2=val2

 

Parameters:

value - The Field value, possibly with parameters.

Returns:

The value.

valueParameters

public static String valueParameters(String value,
 Map<String,String> parameters)

contains

public boolean contains(String search)

Look for a value in a possible multivalued field

Parameters:

search - Values to search for (case-insensitive)

Returns:

True iff the value is contained in the field value entirely or as an element of a quoted comma separated list. List element parameters (eg qualities) are ignored, except if they are q=0, in which case the item itself is ignored.

contains

public static boolean contains(String value,
 String search)

Look for a value in a possible multivalued field

Parameters:

value - The field value to search in.

search - Values to search for (case-insensitive)

Returns:

True iff the value is contained in the field value entirely or as an element of a quoted comma separated list. List element parameters (eg qualities) are ignored, except if they are q=0, in which case the item itself is ignored.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getHeader

public HttpHeader getHeader()

getIntValue

public int getIntValue()

getLongValue

public long getLongValue()

getLowerCaseName

public String getLowerCaseName()

getName

public String getName()

getValue

public String getValue()

getValues

public String[] getValues()

getValueList

public List<String> getValueList()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isSameName

public boolean isSameName(HttpField field)

is

public boolean is(String name)

toString

public String toString()

Overrides:

toString in class Object