org.eclipse.jetty.spdy.api

Class Headers

java.lang.Object

org.eclipse.jetty.spdy.api.Headers

All Implemented Interfaces:

Iterable<Headers.Header>

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Headers.Header A named list of string values.

Constructor Summary

Constructors

Constructor and Description
Headers() Creates an empty modifiable Headers instance.
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

Method Summary

Methods

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()

Methods inherited from class java.lang.Object

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

Constructor Detail

Headers

public Headers()

Creates an empty modifiable Headers instance.

See Also:

Headers(Headers, boolean)

Headers

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

Parameters:

original - the Headers to copy headers from

immutable - whether this instance is immutable

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

names

public Set<String> names()

Returns:

a set of header names

get

public Headers.Header get(String name)

Parameters:

name - the header name

Returns:

the Headers.Header with the given name, or null if no such header exists

put

public void put(String name,
       String value)

Inserts or replaces the given name/value pair as a single-valued Headers.Header.

Parameters:

name - the header name

value - the header value

put

public void put(Headers.Header header)

Inserts or replaces the given Headers.Header, mapped to the header's name

Parameters:

header - the header to add

add

public 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.

Parameters:

name - the header name

value - the header value to add

remove

public Headers.Header remove(String name)

Removes the Headers.Header with the given name

Parameters:

name - the name of the header to remove

Returns:

the removed header, or null if no such header existed

clear

public void clear()

Empties this Headers instance from all headers

See Also:

isEmpty()

isEmpty

public boolean isEmpty()

Returns:

whether this Headers instance is empty

size

public int size()

Returns:

the number of headers

iterator

public Iterator<Headers.Header> iterator()

Specified by:

iterator in interface Iterable<Headers.Header>

Returns:

an iterator over the Headers.Header present in this instance

toString

public String toString()

Overrides:

toString in class Object