org.codehaus.httpcache4j

Class Headers

java.lang.Object

org.codehaus.httpcache4j.Headers

All Implemented Interfaces:

Iterable<Header>, Streamable<Header>

public final class Headers
extends Object
implements Streamable<Header>

A collection of headers. All methods that modify the headers return a new Headers object.

Author:

Erlend Hamnaberg

Constructor Summary

Constructors

Constructor and Description
Headers()
Headers(Headers headers)
Headers(Iterable<Header> headers)
Headers(Map<String,List<String>> headers)

Method Summary

Modifier and Type	Method and Description
Headers	add(Header header)
Headers	add(Iterable<Header> headers)
Headers	add(String name, Iterable<String> values)
Headers	add(String key, String value)
Headers	addAccept(MIMEType... accept)
Headers	addAccept(Preference... accept)
Headers	addAcceptCharset(Preference... accept)
Headers	addAcceptLanguage(Locale... accept)
Headers	addAcceptLanguage(Preference... accept)
Headers	asCacheable()
boolean	contains(Header header)
boolean	contains(String headerName)
boolean	equals(Object o)
List<Preference>	getAccept()
List<Preference>	getAcceptCharset()
List<Preference>	getAcceptLanguage()
Set<HTTPMethod>	getAllow()
Optional<CacheControl>	getCacheControl()
Conditionals	getConditionals()
Optional<Long>	getContentLength()
Optional<URI>	getContentLocation()
Optional<MIMEType>	getContentType()
Optional<LocalDateTime>	getDate()
List<Directives>	getDirectives(String name)
Optional<Tag>	getETag()
Optional<LocalDateTime>	getExpires()
Optional<Header>	getFirstHeader(String headerKey)
Optional<String>	getFirstHeaderValue(String headerKey)
Optional<Directives>	getFirstHeaderValueAsDirectives(String headerKey)
List<Header>	getHeaders(String name)
Optional<LocalDateTime>	getLastModified()
Optional<URI>	getLocation()
int	hashCode()
boolean	hasHeader(String headerName) Deprecated. use contains(String) instead
boolean	isCachable()
boolean	isEmpty()
Iterator<Header>	iterator()
Set<String>	keySet()
static Headers	parse(String input)
Headers	remove(String name)
Headers	set(Header header)
Headers	set(Iterable<Header> headers)
Headers	set(String name, String value)
int	size()
String	toString()
Headers	withAccept(List<Preference> charsets)
Headers	withAcceptCharset(List<Preference> charsets)
Headers	withAcceptLanguage(List<Preference> acceptLanguage)
Headers	withAllow(Set<HTTPMethod> allow)
Headers	withCacheControl(CacheControl cc)
Headers	withConditionals(Conditionals conditionals)
Headers	withContentLength(long length)
Headers	withContentLocation(URI href)
Headers	withContentType(MIMEType ct)
Headers	withDate(LocalDateTime dt)
Headers	withETag(Tag tag)
Headers	withExpires(LocalDateTime expires)
Headers	withLastModified(LocalDateTime lm)
Headers	withLocation(URI href)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.codehaus.httpcache4j.util.Streamable

stream

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Headers

public Headers()

Headers

public Headers(Headers headers)

Headers

public Headers(Iterable<Header> headers)

Headers

public Headers(Map<String,List<String>> headers)

Method Detail

getHeaders

public List<Header> getHeaders(String name)

getDirectives

public List<Directives> getDirectives(String name)

getFirstHeader

public Optional<Header> getFirstHeader(String headerKey)

getFirstHeaderValue

public Optional<String> getFirstHeaderValue(String headerKey)

getFirstHeaderValueAsDirectives

public Optional<Directives> getFirstHeaderValueAsDirectives(String headerKey)

add

public Headers add(Header header)

add

public Headers add(String key,
                   String value)

add

public Headers add(Iterable<Header> headers)

add

public Headers add(String name,
                   Iterable<String> values)

set

public Headers set(Header header)

set

public Headers set(String name,
                   String value)

set

public Headers set(Iterable<Header> headers)

contains

public boolean contains(Header header)

contains

public boolean contains(String headerName)

hasHeader

@Deprecated
public boolean hasHeader(String headerName)

Deprecated. use contains(String) instead

remove

public Headers remove(String name)

iterator

public Iterator<Header> iterator()

Specified by:

iterator in interface Iterable<Header>

keySet

public Set<String> keySet()

size

public int size()

isEmpty

public boolean isEmpty()

asCacheable

public Headers asCacheable()

isCachable

public boolean isCachable()

getAcceptLanguage

public List<Preference> getAcceptLanguage()

withAcceptLanguage

public Headers withAcceptLanguage(List<Preference> acceptLanguage)

getAcceptCharset

public List<Preference> getAcceptCharset()

withAcceptCharset

public Headers withAcceptCharset(List<Preference> charsets)

getAccept

public List<Preference> getAccept()

withAccept

public Headers withAccept(List<Preference> charsets)

addAccept

public Headers addAccept(Preference... accept)

addAccept

public Headers addAccept(MIMEType... accept)

addAcceptLanguage

public Headers addAcceptLanguage(Locale... accept)

addAcceptLanguage

public Headers addAcceptLanguage(Preference... accept)

addAcceptCharset

public Headers addAcceptCharset(Preference... accept)

getAllow

public Set<HTTPMethod> getAllow()

withAllow

public Headers withAllow(Set<HTTPMethod> allow)

getCacheControl

public Optional<CacheControl> getCacheControl()

withCacheControl

public Headers withCacheControl(CacheControl cc)

getDate

public Optional<LocalDateTime> getDate()

withDate

public Headers withDate(LocalDateTime dt)

getContentType

public Optional<MIMEType> getContentType()

withContentType

public Headers withContentType(MIMEType ct)

getExpires

public Optional<LocalDateTime> getExpires()

withExpires

public Headers withExpires(LocalDateTime expires)

getLastModified

public Optional<LocalDateTime> getLastModified()

withLastModified

public Headers withLastModified(LocalDateTime lm)

getConditionals

public Conditionals getConditionals()

withConditionals

public Headers withConditionals(Conditionals conditionals)

getETag

public Optional<Tag> getETag()

withETag

public Headers withETag(Tag tag)

getLocation

public Optional<URI> getLocation()

withLocation

public Headers withLocation(URI href)

getContentLength

public Optional<Long> getContentLength()

withContentLength

public Headers withContentLength(long length)

getContentLocation

public Optional<URI> getContentLocation()

withContentLocation

public Headers withContentLocation(URI href)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

parse

public static Headers parse(String input)