groovyx.net.http

Class FromServer.Header<T>

java.lang.Object

groovyx.net.http.FromServer.Header<T>

All Implemented Interfaces:

java.util.Map.Entry<java.lang.String,java.lang.String>

Direct Known Subclasses:

FromServer.Header.CombinedMap, FromServer.Header.CsvList, FromServer.Header.HttpCookies, FromServer.Header.HttpDate, FromServer.Header.MapPairs, FromServer.Header.SingleLong, FromServer.Header.ValueOnly

Enclosing interface:

FromServer

public abstract static class FromServer.Header<T>
extends java.lang.Object
implements java.util.Map.Entry<java.lang.String,java.lang.String>

Defines the interface to the HTTP headers contained in the response. (see also List of HTTP Header Fields)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FromServer.Header.CombinedMap Type representing headers that have values which are parseable as key/value pairs, provided the header hey is included in the key/value map.
static class	FromServer.Header.CsvList Type representing headers that have values which are comma separated lists.
static class	FromServer.Header.HttpCookies
static class	FromServer.Header.HttpDate Type representing headers that have values which are zoned date time values.
static class	FromServer.Header.MapPairs Type representing headers that have values which are parseable as key/value pairs.
static class	FromServer.Header.SingleLong Type representing headers that have values which are parseable as longs.
static class	FromServer.Header.ValueOnly Type representing headers that are simple key/values, with no parseable structure in the value.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Header(java.lang.String key, java.lang.String value)

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	cleanQuotes(java.lang.String str)
boolean	equals(java.lang.Object o)
static FromServer.Header<?>	find(java.util.Collection<FromServer.Header<?>> headers, java.lang.String key) Used to find a specific Header by key from a Collection of `Header`s.
static FromServer.Header<?>	full(java.lang.String raw) Creates a Header from a full header string.
java.lang.String	getKey() Retrieves the header key.
T	getParsed() Retrieves the parsed representation of the 'value`.
abstract java.lang.Class<?>	getParsedType() Retrieves the type of the parsed representation of the 'value`.
java.lang.String	getValue() Retrieves the header value.
int	hashCode()
protected static java.lang.String	key(java.lang.String raw)
static FromServer.Header<?>	keyValue(java.lang.String key, java.lang.String value) Creates a Header from a given key and value.
protected abstract T	parse() Performs the parse of the value
java.lang.String	setValue(java.lang.String val) Unsupported, headers are read-only.
java.lang.String	toString()
protected static java.lang.String	value(java.lang.String raw)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map.Entry

comparingByKey, comparingByKey, comparingByValue, comparingByValue

Constructor Detail

Header

protected Header(java.lang.String key,
                 java.lang.String value)

Method Detail

key

protected static java.lang.String key(java.lang.String raw)

cleanQuotes

protected static java.lang.String cleanQuotes(java.lang.String str)

value

protected static java.lang.String value(java.lang.String raw)

getKey

public java.lang.String getKey()

Retrieves the header key.

Specified by:

getKey in interface java.util.Map.Entry<java.lang.String,java.lang.String>

Returns:

the header key

getValue

public java.lang.String getValue()

Retrieves the header value.

Specified by:

getValue in interface java.util.Map.Entry<java.lang.String,java.lang.String>

Returns:

the header value

setValue

public java.lang.String setValue(java.lang.String val)

Unsupported, headers are read-only.

Specified by:

setValue in interface java.util.Map.Entry<java.lang.String,java.lang.String>

Throws:

java.lang.UnsupportedOperationException - always

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Map.Entry<java.lang.String,java.lang.String>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map.Entry<java.lang.String,java.lang.String>

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getParsed

public T getParsed()

Retrieves the parsed representation of the 'value`. The type of the returned Object depends on the header and will be given by the getParsedType() property.

Returns:

the parsed header value

getParsedType

public abstract java.lang.Class<?> getParsedType()

Retrieves the type of the parsed representation of the 'value`.

Returns:

the parsed header value type

parse

protected abstract T parse()

Performs the parse of the value

Returns:

the parsed header value

full

public static FromServer.Header<?> full(java.lang.String raw)

Creates a Header from a full header string. The string format is colon-delimited as KEY:VALUE.

Header header = Header.full('Content-Type:text/plain')
assert header.key == 'Content-Type'
assert header.value == 'text/plain'

Parameters:

raw - the full header string

Returns:

the Header representing the given header string

keyValue

public static FromServer.Header<?> keyValue(java.lang.String key,
                                            java.lang.String value)

Creates a Header from a given key and value.

Parameters:

key - the header key

value - the header value

Returns:

the populated Header

find

public static FromServer.Header<?> find(java.util.Collection<FromServer.Header<?>> headers,
                                        java.lang.String key)

Used to find a specific Header by key from a Collection of `Header`s.

Parameters:

headers - the Collection of `Header`s to be searched

key - the key of the desired Header

Returns:

the Header with the matching key (or null)