public class HttpFields extends Object implements Iterable<HttpField>
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.
Modifier and Type | Field and Description |
---|---|
static String |
__separators
Deprecated.
|
Constructor and Description |
---|
HttpFields()
Initialize an empty HttpFields.
|
HttpFields(HttpFields fields)
Initialize HttpFields from copy.
|
HttpFields(int capacity)
Initialize an empty HttpFields.
|
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) |
boolean |
addCSV(HttpHeader header,
String... values)
Add comma separated values, but only if not already
present.
|
boolean |
addCSV(String name,
String... values)
Add comma separated values, but only if not already
present.
|
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.
|
List<HttpField> |
getFields(HttpHeader header) |
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(HttpHeader header,
ToIntFunction<String> secondaryOrdering)
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() |
ListIterator<HttpField> |
listIterator() |
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() |
Stream<HttpField> |
stream() |
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.
|
forEach, spliterator
@Deprecated public static final String __separators
public HttpFields()
public HttpFields(int capacity)
capacity
- the capacity of the http fieldspublic HttpFields(HttpFields fields)
fields
- the fields to copy data frompublic int size()
public ListIterator<HttpField> listIterator()
public Set<String> getFieldNamesCollection()
public Enumeration<String> getFieldNames()
public HttpField getField(int index)
index
- the field indexpublic HttpField getField(HttpHeader header)
public List<HttpField> getFields(HttpHeader header)
public boolean contains(HttpField field)
public boolean contains(HttpHeader header, String value)
public boolean contains(HttpHeader header)
public boolean containsKey(String name)
@Deprecated public String getStringField(HttpHeader header)
public String get(HttpHeader header)
@Deprecated public String getStringField(String name)
public List<String> getValuesList(HttpHeader header)
header
- the headerpublic List<String> getValuesList(String name)
name
- the case-insensitive field namepublic boolean addCSV(HttpHeader header, String... values)
header
- The header to add the value(s) tovalues
- The value(s) to addpublic boolean addCSV(String name, String... values)
name
- The header to add the value(s) tovalues
- The value(s) to addpublic List<String> getCSV(HttpHeader header, boolean keepQuotes)
QuotedCSV
header
- The headerkeepQuotes
- True if the fields are kept quotedpublic List<String> getCSV(String name, boolean keepQuotes)
QuotedCSV
name
- the case-insensitive field namekeepQuotes
- True if the fields are kept quotedpublic List<String> getQualityCSV(HttpHeader header)
QuotedQualityCSV
header
- The headerpublic List<String> getQualityCSV(HttpHeader header, ToIntFunction<String> secondaryOrdering)
QuotedQualityCSV
header
- The headersecondaryOrdering
- Function to apply an ordering other than specified by qualitypublic List<String> getQualityCSV(String name)
QuotedQualityCSV
name
- the case-insensitive field namepublic Enumeration<String> getValues(String name)
name
- the case-insensitive field name@Deprecated public Enumeration<String> getValues(String name, String separators)
name
- the case-insensitive field nameseparators
- String of separators.public void put(HttpField field)
public void put(String name, String value)
name
- the name of the fieldvalue
- the value of the field. If null the field is cleared.public void put(HttpHeader header, HttpHeaderValue value)
public void put(HttpHeader header, String value)
header
- the header name of the fieldvalue
- the value of the field. If null the field is cleared.public void put(String name, List<String> list)
name
- the name of the fieldlist
- the List value of the field. If null the field is cleared.public void add(String name, String value)
name
- the name of the fieldvalue
- the value of the field.public void add(HttpHeader header, HttpHeaderValue value)
public void add(HttpHeader header, String value)
header
- the headervalue
- the value of the field.public HttpField remove(HttpHeader name)
name
- the field to removepublic HttpField remove(String name)
name
- the field to removepublic long getLongField(String name) throws NumberFormatException
name
- the case-insensitive field nameNumberFormatException
- If bad long foundpublic long getDateField(String name)
name
- the case-insensitive field namepublic void putLongField(HttpHeader name, long value)
name
- the field namevalue
- the field long valuepublic void putLongField(String name, long value)
name
- the field namevalue
- the field long valuepublic void putDateField(HttpHeader name, long date)
name
- the field namedate
- the field date valuepublic void putDateField(String name, long date)
name
- the field namedate
- the field date valuepublic void addDateField(String name, long date)
name
- the field namedate
- the field date valuepublic void clear()
public void add(HttpField field)
public void addAll(HttpFields fields)
public void add(HttpFields fields)
fields
- the fields to addpublic static String stripParameters(String value)
FieldName : Value ; param1=val1 ; param2=val2
value
- The Field value, possibly with parameters.public static String valueParameters(String value, Map<String,String> parameters)
FieldName : Value ; param1=val1 ; param2=val2
value
- The Field value, possibly with parameters.parameters
- A map to populate with the parameters, or null@Deprecated public static Float getQuality(String value)
@Deprecated public static List<String> qualityList(Enumeration<String> e)
e
- Enumeration of values with quality parametersCopyright © 2010 - 2020 Adobe. All Rights Reserved