java.lang.Iterable<HttpField>
public class HttpFields extends java.lang.Object implements java.lang.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 | Description |
---|---|---|
static java.lang.String |
__separators |
Deprecated.
|
Constructor | Description |
---|---|
HttpFields() |
Initialize an empty HttpFields.
|
HttpFields(int capacity) |
Initialize an empty HttpFields.
|
HttpFields(HttpFields fields) |
Initialize HttpFields from copy.
|
Modifier and Type | Method | Description |
---|---|---|
void |
add(java.lang.String name,
java.lang.String value) |
Add to or set a field.
|
void |
add(HttpField field) |
|
void |
add(HttpFields fields) |
Add fields from another HttpFields instance.
|
void |
add(HttpHeader header,
java.lang.String value) |
Add to or set a field.
|
void |
add(HttpHeader header,
HttpHeaderValue value) |
|
void |
addAll(HttpFields fields) |
|
boolean |
addCSV(java.lang.String name,
java.lang.String... values) |
Add comma separated values, but only if not already
present.
|
boolean |
addCSV(HttpHeader header,
java.lang.String... values) |
Add comma separated values, but only if not already
present.
|
protected java.lang.String |
addCSV(QuotedCSV existing,
java.lang.String... values) |
|
void |
addDateField(java.lang.String name,
long date) |
Sets the value of a date field.
|
void |
clear() |
|
boolean |
contains(java.lang.String name,
java.lang.String value) |
|
boolean |
contains(HttpField field) |
|
boolean |
contains(HttpHeader header) |
|
boolean |
contains(HttpHeader header,
java.lang.String value) |
|
boolean |
containsKey(java.lang.String name) |
|
boolean |
equals(java.lang.Object o) |
|
java.lang.String |
get(java.lang.String header) |
|
java.lang.String |
get(HttpHeader header) |
|
java.util.List<java.lang.String> |
getCSV(java.lang.String name,
boolean keepQuotes) |
Get multiple field values of the same name
as a
QuotedCSV |
java.util.List<java.lang.String> |
getCSV(HttpHeader header,
boolean keepQuotes) |
Get multiple field values of the same name, split
as a
QuotedCSV |
long |
getDateField(java.lang.String name) |
Get a header as a date value.
|
HttpField |
getField(int index) |
Get a Field by index.
|
HttpField |
getField(java.lang.String name) |
|
HttpField |
getField(HttpHeader header) |
|
java.util.Enumeration<java.lang.String> |
getFieldNames() |
Get enumeration of header _names.
|
java.util.Set<java.lang.String> |
getFieldNamesCollection() |
Get Collection of header names.
|
long |
getLongField(java.lang.String name) |
Get a header as an long value.
|
static java.lang.Float |
getQuality(java.lang.String value) |
Deprecated.
|
java.util.List<java.lang.String> |
getQualityCSV(java.lang.String name) |
Get multiple field values of the same name, split and
sorted as a
QuotedQualityCSV |
java.util.List<java.lang.String> |
getQualityCSV(HttpHeader header) |
Get multiple field values of the same name, split and
sorted as a
QuotedQualityCSV |
java.lang.String |
getStringField(java.lang.String name) |
Deprecated.
|
java.lang.String |
getStringField(HttpHeader header) |
Deprecated.
|
java.util.Enumeration<java.lang.String> |
getValues(java.lang.String name) |
Get multi headers
|
java.util.Enumeration<java.lang.String> |
getValues(java.lang.String name,
java.lang.String separators) |
Deprecated.
|
java.util.List<java.lang.String> |
getValuesList(java.lang.String name) |
Get multiple header of the same name
|
java.util.List<java.lang.String> |
getValuesList(HttpHeader header) |
Get multiple header of the same name
|
int |
hashCode() |
|
java.util.Iterator<HttpField> |
iterator() |
|
void |
put(java.lang.String name,
java.lang.String value) |
Set a field.
|
void |
put(java.lang.String name,
java.util.List<java.lang.String> list) |
Set a field.
|
void |
put(HttpField field) |
|
void |
put(HttpHeader header,
java.lang.String value) |
Set a field.
|
void |
put(HttpHeader header,
HttpHeaderValue value) |
|
void |
putDateField(java.lang.String name,
long date) |
Sets the value of a date field.
|
void |
putDateField(HttpHeader name,
long date) |
Sets the value of a date field.
|
void |
putLongField(java.lang.String name,
long value) |
Sets the value of an long field.
|
void |
putLongField(HttpHeader name,
long value) |
Sets the value of an long field.
|
static java.util.List<java.lang.String> |
qualityList(java.util.Enumeration<java.lang.String> e) |
Deprecated.
|
HttpField |
remove(java.lang.String name) |
Remove a field.
|
HttpField |
remove(HttpHeader name) |
Remove a field.
|
int |
size() |
|
java.util.stream.Stream<HttpField> |
stream() |
|
static java.lang.String |
stripParameters(java.lang.String value) |
Get field value without parameters.
|
java.lang.String |
toString() |
|
static java.lang.String |
valueParameters(java.lang.String value,
java.util.Map<java.lang.String,java.lang.String> parameters) |
Get field value parameters.
|
@Deprecated public static final java.lang.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 java.util.Iterator<HttpField> iterator()
iterator
in interface java.lang.Iterable<HttpField>
public java.util.stream.Stream<HttpField> stream()
public java.util.Set<java.lang.String> getFieldNamesCollection()
public java.util.Enumeration<java.lang.String> getFieldNames()
public HttpField getField(int index)
index
- the field indexpublic HttpField getField(HttpHeader header)
public HttpField getField(java.lang.String name)
public boolean contains(HttpField field)
public boolean contains(HttpHeader header, java.lang.String value)
public boolean contains(java.lang.String name, java.lang.String value)
public boolean contains(HttpHeader header)
public boolean containsKey(java.lang.String name)
@Deprecated public java.lang.String getStringField(HttpHeader header)
public java.lang.String get(HttpHeader header)
@Deprecated public java.lang.String getStringField(java.lang.String name)
public java.lang.String get(java.lang.String header)
public java.util.List<java.lang.String> getValuesList(HttpHeader header)
header
- the headerpublic java.util.List<java.lang.String> getValuesList(java.lang.String name)
name
- the case-insensitive field namepublic boolean addCSV(HttpHeader header, java.lang.String... values)
header
- The header to add the value(s) tovalues
- The value(s) to addpublic boolean addCSV(java.lang.String name, java.lang.String... values)
name
- The header to add the value(s) tovalues
- The value(s) to addprotected java.lang.String addCSV(QuotedCSV existing, java.lang.String... values)
public java.util.List<java.lang.String> getCSV(HttpHeader header, boolean keepQuotes)
QuotedCSV
header
- The headerkeepQuotes
- True if the fields are kept quotedpublic java.util.List<java.lang.String> getCSV(java.lang.String name, boolean keepQuotes)
QuotedCSV
name
- the case-insensitive field namekeepQuotes
- True if the fields are kept quotedpublic java.util.List<java.lang.String> getQualityCSV(HttpHeader header)
QuotedQualityCSV
header
- The headerpublic java.util.List<java.lang.String> getQualityCSV(java.lang.String name)
QuotedQualityCSV
name
- the case-insensitive field namepublic java.util.Enumeration<java.lang.String> getValues(java.lang.String name)
name
- the case-insensitive field name@Deprecated public java.util.Enumeration<java.lang.String> getValues(java.lang.String name, java.lang.String separators)
name
- the case-insensitive field nameseparators
- String of separators.public void put(HttpField field)
public void put(java.lang.String name, java.lang.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, java.lang.String value)
header
- the header name of the fieldvalue
- the value of the field. If null the field is cleared.public void put(java.lang.String name, java.util.List<java.lang.String> list)
name
- the name of the fieldlist
- the List value of the field. If null the field is cleared.public void add(java.lang.String name, java.lang.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, java.lang.String value)
header
- the headervalue
- the value of the field.public HttpField remove(HttpHeader name)
name
- the field to removepublic HttpField remove(java.lang.String name)
name
- the field to removepublic long getLongField(java.lang.String name) throws java.lang.NumberFormatException
name
- the case-insensitive field namejava.lang.NumberFormatException
- If bad long foundpublic long getDateField(java.lang.String name)
name
- the case-insensitive field namepublic void putLongField(HttpHeader name, long value)
name
- the field namevalue
- the field long valuepublic void putLongField(java.lang.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(java.lang.String name, long date)
name
- the field namedate
- the field date valuepublic void addDateField(java.lang.String name, long date)
name
- the field namedate
- the field date valuepublic int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public void clear()
public void add(HttpField field)
public void addAll(HttpFields fields)
public void add(HttpFields fields)
fields
- the fields to addpublic static java.lang.String stripParameters(java.lang.String value)
FieldName : Value ; param1=val1 ; param2=val2
value
- The Field value, possibly with parameters.public static java.lang.String valueParameters(java.lang.String value, java.util.Map<java.lang.String,java.lang.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 java.lang.Float getQuality(java.lang.String value)
@Deprecated public static java.util.List<java.lang.String> qualityList(java.util.Enumeration<java.lang.String> e)
e
- Enumeration of values with quality parametersCopyright © 1995–2017 Webtide. All rights reserved.