public class Headers extends Object implements Iterable<Headers.Header>
A container for name/value pairs, known as headers.
A Headers.Header
is composed of a case-insensitive name string and
of a case-sensitive set of value strings.
The implementation of this class is not thread safe.
Modifier and Type | Class and Description |
---|---|
static class |
Headers.Header
A named list of string values.
|
Constructor and Description |
---|
Headers()
Creates an empty modifiable
Headers instance. |
Headers(Headers original,
boolean immutable)
|
Modifier and Type | Method and Description |
---|---|
void |
add(String name,
String value)
Adds the given value to a header with the given name, creating a
Headers.Header is none exists
for the given name. |
void |
clear()
Empties this
Headers instance from all headers |
boolean |
equals(Object obj) |
Headers.Header |
get(String name) |
int |
hashCode() |
boolean |
isEmpty() |
Iterator<Headers.Header> |
iterator() |
Set<String> |
names() |
void |
put(Headers.Header header)
Inserts or replaces the given
Headers.Header , mapped to the header's name |
void |
put(String name,
String value)
Inserts or replaces the given name/value pair as a single-valued
Headers.Header . |
Headers.Header |
remove(String name)
Removes the
Headers.Header with the given name |
int |
size() |
String |
toString() |
public Headers()
Creates an empty modifiable Headers
instance.
Headers(Headers, boolean)
public Headers(Headers original, boolean immutable)
Creates a Headers
instance by copying the headers from the given
Headers
and making it (im)mutable depending on the given immutable
parameter
original
- the Headers
to copy headers fromimmutable
- whether this instance is immutablepublic Headers.Header get(String name)
name
- the header nameHeaders.Header
with the given name, or null if no such header existspublic void put(String name, String value)
Inserts or replaces the given name/value pair as a single-valued Headers.Header
.
name
- the header namevalue
- the header valuepublic void put(Headers.Header header)
Inserts or replaces the given Headers.Header
, mapped to the header's name
header
- the header to addpublic void add(String name, String value)
Adds the given value to a header with the given name, creating a Headers.Header
is none exists
for the given name.
name
- the header namevalue
- the header value to addpublic Headers.Header remove(String name)
Removes the Headers.Header
with the given name
name
- the name of the header to removepublic boolean isEmpty()
Headers
instance is emptypublic int size()
public Iterator<Headers.Header> iterator()
iterator
in interface Iterable<Headers.Header>
Headers.Header
present in this instanceCopyright © 1995-2015 Mort Bay Consulting. All Rights Reserved.