HttpFields (Jetty :: Http Utility 9.3.11.v20160721 API)

java.lang.Object
- org.eclipse.jetty.http.HttpFields

All Implemented Interfaces:

Iterable<HttpField>
```
public class HttpFields
extends Object
implements Iterable<HttpField>
```
HTTP Fields. A collection of HTTP header and or Trailer fields.
This class is not synchronized as it is expected that modifications will only be performed by a single thread.
The cookie handling provided by this class is guided by the Servlet specification and RFC6265.

Field Summary

Fields
Modifier and Type Field and Description

static String __separators
Deprecated.

Fields
Modifier and Type	Field and Description
`static String`	`__separators` Deprecated.

Constructor Summary

Constructors
Constructor and Description
`HttpFields()` Initialize an empty HttpFields.
`HttpFields(HttpFields fields)` Initialize HttpFields from copy.
`HttpFields(int capacity)` Initialize an empty HttpFields.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`add(HttpField field)`
`void`	`add(HttpFields fields)` Add fields from another HttpFields instance.
`void`	`add(HttpHeader header, HttpHeaderValue value)`
`void`	`add(HttpHeader header, String value)` Add to or set a field.
`void`	`add(String name, String value)` Add to or set a field.
`void`	`addAll(HttpFields fields)`
`void`	`addDateField(String name, long date)` Sets the value of a date field.
`void`	`clear()`
`boolean`	`contains(HttpField field)`
`boolean`	`contains(HttpHeader header)`
`boolean`	`contains(HttpHeader header, String value)`
`boolean`	`contains(String name, String value)`
`boolean`	`containsKey(String name)`
`boolean`	`equals(Object o)`
`String`	`get(HttpHeader header)`
`String`	`get(String header)`
`List<String>`	`getCSV(HttpHeader header, boolean keepQuotes)` Get multiple field values of the same name, split as a `QuotedCSV`
`List<String>`	`getCSV(String name, boolean keepQuotes)` Get multiple field values of the same name as a `QuotedCSV`
`long`	`getDateField(String name)` Get a header as a date value.
`HttpField`	`getField(HttpHeader header)`
`HttpField`	`getField(int index)` Get a Field by index.
`HttpField`	`getField(String name)`
`Enumeration<String>`	`getFieldNames()` Get enumeration of header _names.
`Set<String>`	`getFieldNamesCollection()` Get Collection of header names.
`long`	`getLongField(String name)` Get a header as an long value.
`static Float`	`getQuality(String value)` Deprecated.
`List<String>`	`getQualityCSV(HttpHeader header)` Get multiple field values of the same name, split and sorted as a `QuotedQualityCSV`
`List<String>`	`getQualityCSV(String name)` Get multiple field values of the same name, split and sorted as a `QuotedQualityCSV`
`String`	`getStringField(HttpHeader header)` Deprecated.
`String`	`getStringField(String name)` Deprecated.
`Enumeration<String>`	`getValues(String name)` Get multi headers
`Enumeration<String>`	`getValues(String name, String separators)` Deprecated.
`List<String>`	`getValuesList(HttpHeader header)` Get multiple header of the same name
`List<String>`	`getValuesList(String name)` Get multiple header of the same name
`int`	`hashCode()`
`Iterator<HttpField>`	`iterator()`
`void`	`put(HttpField field)`
`void`	`put(HttpHeader header, HttpHeaderValue value)`
`void`	`put(HttpHeader header, String value)` Set a field.
`void`	`put(String name, List<String> list)` Set a field.
`void`	`put(String name, String value)` Set a field.
`void`	`putDateField(HttpHeader name, long date)` Sets the value of a date field.
`void`	`putDateField(String name, long date)` Sets the value of a date field.
`void`	`putLongField(HttpHeader name, long value)` Sets the value of an long field.
`void`	`putLongField(String name, long value)` Sets the value of an long field.
`static List<String>`	`qualityList(Enumeration<String> e)` Deprecated.
`HttpField`	`remove(HttpHeader name)` Remove a field.
`HttpField`	`remove(String name)` Remove a field.
`int`	`size()`
`static String`	`stripParameters(String value)` Get field value without parameters.
`String`	`toString()`
`static String`	`valueParameters(String value, Map<String,String> parameters)` Get field value parameters.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - __separators
```
@Deprecated
public static final String __separators
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HttpFields
```
public HttpFields()
```
    Initialize an empty HttpFields.
  - HttpFields
```
public HttpFields(int capacity)
```
    Initialize an empty HttpFields.
    
    Parameters:
    
    capacity - the capacity of the http fields
  - HttpFields
```
public HttpFields(HttpFields fields)
```
    Initialize HttpFields from copy.
    
    Parameters:
    
    fields - the fields to copy data from
- Method Detail
  - size
```
public int size()
```
  - iterator
```
public Iterator<HttpField> iterator()
```
    Specified by:
    
    iterator in interface Iterable<HttpField>
  - getFieldNamesCollection
```
public Set<String> getFieldNamesCollection()
```
    Get Collection of header names.
    
    Returns:
    
    the unique set of field names.
  - getFieldNames
```
public Enumeration<String> getFieldNames()
```
    Get enumeration of header _names. Returns an enumeration of strings representing the header _names for this request.
    
    Returns:
    
    an enumeration of field names
  - getField
```
public HttpField getField(int index)
```
    Get a Field by index.
    
    Parameters:
    
    index - the field index
    
    Returns:
    
    A Field value or null if the Field value has not been set
  - getField
```
public HttpField getField(HttpHeader header)
```
  - getField
```
public HttpField getField(String name)
```
  - contains
```
public boolean contains(HttpField field)
```
  - contains
```
public boolean contains(HttpHeader header,
                        String value)
```
  - contains
```
public boolean contains(String name,
                        String value)
```
  - contains
```
public boolean contains(HttpHeader header)
```
  - containsKey
```
public boolean containsKey(String name)
```
  - getStringField
```
@Deprecated
public String getStringField(HttpHeader header)
```
    Deprecated.
  - get
```
public String get(HttpHeader header)
```
  - getStringField
```
@Deprecated
public String getStringField(String name)
```
    Deprecated.
  - get
```
public String get(String header)
```
  - getValuesList
```
public List<String> getValuesList(HttpHeader header)
```
    Get multiple header of the same name
    
    Parameters:
    
    header - the header
    
    Returns:
    
    List the values
  - getValuesList
```
public List<String> getValuesList(String name)
```
    Get multiple header of the same name
    
    Parameters:
    
    name - the case-insensitive field name
    
    Returns:
    
    List the header values
  - getCSV
```
public List<String> getCSV(HttpHeader header,
                           boolean keepQuotes)
```
    Get multiple field values of the same name, split as a QuotedCSV
    
    Parameters:
    
    header - The header
    
    keepQuotes - True if the fields are kept quoted
    
    Returns:
    
    List the values with OWS stripped
  - getCSV
```
public List<String> getCSV(String name,
                           boolean keepQuotes)
```
    Get multiple field values of the same name as a QuotedCSV
    
    Parameters:
    
    name - the case-insensitive field name
    
    keepQuotes - True if the fields are kept quoted
    
    Returns:
    
    List the values with OWS stripped
  - getQualityCSV
```
public List<String> getQualityCSV(HttpHeader header)
```
    Get multiple field values of the same name, split and sorted as a QuotedQualityCSV
    
    Parameters:
    
    header - The header
    
    Returns:
    
    List the values in quality order with the q param and OWS stripped
  - getQualityCSV
```
public List<String> getQualityCSV(String name)
```
    Get multiple field values of the same name, split and sorted as a QuotedQualityCSV
    
    Parameters:
    
    name - the case-insensitive field name
    
    Returns:
    
    List the values in quality order with the q param and OWS stripped
  - getValues
```
public Enumeration<String> getValues(String name)
```
    Get multi headers
    
    Parameters:
    
    name - the case-insensitive field name
    
    Returns:
    
    Enumeration of the values
  - getValues
```
@Deprecated
public Enumeration<String> getValues(String name,
                                                 String separators)
```
    Deprecated.
    
    Get multi field values with separator. The multiple values can be represented as separate headers of the same name, or by a single header using the separator(s), or a combination of both. Separators may be quoted.
    
    Parameters:
    
    name - the case-insensitive field name
    
    separators - String of separators.
    
    Returns:
    
    Enumeration of the values, or null if no such header.
  - put
```
public void put(HttpField field)
```
  - put
```
public void put(String name,
                String value)
```
    Set a field.
    
    Parameters:
    
    name - the name of the field
    
    value - the value of the field. If null the field is cleared.
  - put
```
public void put(HttpHeader header,
                HttpHeaderValue value)
```
  - put
```
public void put(HttpHeader header,
                String value)
```
    Set a field.
    
    Parameters:
    
    header - the header name of the field
    
    value - the value of the field. If null the field is cleared.
  - put
```
public void put(String name,
                List<String> list)
```
    Set a field.
    
    Parameters:
    
    name - the name of the field
    
    list - the List value of the field. If null the field is cleared.
  - add
```
public void add(String name,
                String value)
```
    Add to or set a field. If the field is allowed to have multiple values, add will add multiple headers of the same name.
    
    Parameters:
    
    name - the name of the field
    
    value - the value of the field.
  - add
```
public void add(HttpHeader header,
                HttpHeaderValue value)
```
  - add
```
public void add(HttpHeader header,
                String value)
```
    Add to or set a field. If the field is allowed to have multiple values, add will add multiple headers of the same name.
    
    Parameters:
    
    header - the header
    
    value - the value of the field.
  - remove
```
public HttpField remove(HttpHeader name)
```
    Remove a field.
    
    Parameters:
    
    name - the field to remove
    
    Returns:
    
    the header that was removed
  - remove
```
public HttpField remove(String name)
```
    Remove a field.
    
    Parameters:
    
    name - the field to remove
    
    Returns:
    
    the header that was removed
  - getLongField
```
public long getLongField(String name)
                  throws NumberFormatException
```
    Get a header as an long value. Returns the value of an integer field or -1 if not found. The case of the field name is ignored.
    
    Parameters:
    
    name - the case-insensitive field name
    
    Returns:
    
    the value of the field as a long
    
    Throws:
    
    NumberFormatException - If bad long found
  - getDateField
```
public long getDateField(String name)
```
    Get a header as a date value. Returns the value of a date field, or -1 if not found. The case of the field name is ignored.
    
    Parameters:
    
    name - the case-insensitive field name
    
    Returns:
    
    the value of the field as a number of milliseconds since unix epoch
  - putLongField
```
public void putLongField(HttpHeader name,
                         long value)
```
    Sets the value of an long field.
    
    Parameters:
    
    name - the field name
    
    value - the field long value
  - putLongField
```
public void putLongField(String name,
                         long value)
```
    Sets the value of an long field.
    
    Parameters:
    
    name - the field name
    
    value - the field long value
  - putDateField
```
public void putDateField(HttpHeader name,
                         long date)
```
    Sets the value of a date field.
    
    Parameters:
    
    name - the field name
    
    date - the field date value
  - putDateField
```
public void putDateField(String name,
                         long date)
```
    Sets the value of a date field.
    
    Parameters:
    
    name - the field name
    
    date - the field date value
  - addDateField
```
public void addDateField(String name,
                         long date)
```
    Sets the value of a date field.
    
    Parameters:
    
    name - the field name
    
    date - the field date value
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clear
```
public void clear()
```
  - add
```
public void add(HttpField field)
```
  - addAll
```
public void addAll(HttpFields fields)
```
  - add
```
public void add(HttpFields fields)
```
    Add fields from another HttpFields instance. Single valued fields are replaced, while all others are added.
    
    Parameters:
    
    fields - the fields to add
  - 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)
```
    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:
    
    value - The Field value, possibly with parameters.
    
    parameters - A map to populate with the parameters, or null
    
    Returns:
    
    The value.
  - getQuality
```
@Deprecated
public static Float getQuality(String value)
```
    Deprecated.
  - qualityList
```
@Deprecated
public static List<String> qualityList(Enumeration<String> e)
```
    Deprecated.
    
    List values in quality order.
    
    Parameters:
    
    e - Enumeration of values with quality parameters
    
    Returns:
    
    values in quality order.

Class HttpFields

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

__separators

Constructor Detail

HttpFields

HttpFields

HttpFields

Method Detail

size

iterator

getFieldNamesCollection

getFieldNames

getField

getField

getField

contains

contains

contains

contains

containsKey

getStringField

get

getStringField

get

getValuesList

getValuesList

getCSV

getCSV

getQualityCSV

getQualityCSV

getValues

getValues

put

put

put

put

put

add

add

add

remove

remove

getLongField

getDateField

putLongField

putLongField

putDateField

putDateField

addDateField

hashCode

equals

toString

clear

add

addAll

add

stripParameters

valueParameters

getQuality

qualityList