io.netty.handler.codec.stomp

Class DefaultStompHeaders

java.lang.Object

io.netty.handler.codec.DefaultHeaders<CharSequence>

io.netty.handler.codec.stomp.DefaultStompHeaders

All Implemented Interfaces:

Headers<CharSequence>, StompHeaders, Iterable<Map.Entry<CharSequence,CharSequence>>

public class DefaultStompHeaders
extends DefaultHeaders<CharSequence>
implements StompHeaders

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.handler.codec.DefaultHeaders

DefaultHeaders.HeaderDateFormat, DefaultHeaders.HeaderEntry<T>, DefaultHeaders.NameValidator<T>

Field Summary

Fields inherited from class io.netty.handler.codec.DefaultHeaders

head

Fields inherited from interface io.netty.handler.codec.stomp.StompHeaders

ACCEPT_VERSION, ACK, CONTENT_LENGTH, CONTENT_TYPE, DESTINATION, HEART_BEAT, HOST, ID, LOGIN, MESSAGE, MESSAGE_ID, PASSCODE, RECEIPT, RECEIPT_ID, SERVER, SESSION, SUBSCRIPTION, TRANSACTION, VERSION

Constructor Summary

Constructors

Constructor and Description
DefaultStompHeaders()

Method Summary

Methods

Modifier and Type	Method and Description
StompHeaders	add(CharSequence name, CharSequence... values) Adds new headers with the specified name and values.
StompHeaders	add(CharSequence name, CharSequence value) Adds a new header with the specified name and value.
StompHeaders	add(CharSequence name, Iterable<? extends CharSequence> values) Adds new headers with the specified name and values.
StompHeaders	add(Headers<? extends CharSequence> headers) Adds all header names and values of headers to this object.
StompHeaders	addBoolean(CharSequence name, boolean value) Adds a new header.
StompHeaders	addByte(CharSequence name, byte value) Adds a new header.
StompHeaders	addChar(CharSequence name, char value) Adds a new header.
StompHeaders	addDouble(CharSequence name, double value) Adds a new header.
StompHeaders	addFloat(CharSequence name, float value) Adds a new header.
StompHeaders	addInt(CharSequence name, int value) Adds a new header.
StompHeaders	addLong(CharSequence name, long value) Adds a new header.
StompHeaders	addObject(CharSequence name, Iterable<?> values) Adds a new header with the specified name and values.
StompHeaders	addObject(CharSequence name, Object... values) Adds a new header with the specified name and values.
StompHeaders	addObject(CharSequence name, Object value) Adds a new header.
StompHeaders	addShort(CharSequence name, short value) Adds a new header.
StompHeaders	addTimeMillis(CharSequence name, long value) Adds a new header.
StompHeaders	clear() Removes all headers.
boolean	contains(CharSequence name, CharSequence value) Returns true if a header with the name and value exists, false otherwise.
boolean	contains(CharSequence name, CharSequence value, boolean ignoreCase) Returns true if a header with the name and value exists, false otherwise.
List<String>	getAllAsString(CharSequence name) Headers.getAll(Object) and convert each element of List to a String.
String	getAsString(CharSequence name) Headers.get(Object) and convert the result to a String.
Iterator<Map.Entry<String,String>>	iteratorAsString() Headers.iterator() that converts each Map.Entry's key and value to a String.
StompHeaders	set(CharSequence name, CharSequence... values) Sets a header with the specified name and values.
StompHeaders	set(CharSequence name, CharSequence value) Sets a header with the specified name and value.
StompHeaders	set(CharSequence name, Iterable<? extends CharSequence> values) Sets a new header with the specified name and values.
StompHeaders	set(Headers<? extends CharSequence> headers) Clears the current header entries and copies all header entries of the specified headers.
StompHeaders	setAll(Headers<? extends CharSequence> headers) Retains all current headers but calls #set(T, T) for each entry in headers.
StompHeaders	setBoolean(CharSequence name, boolean value) Set the name to value.
StompHeaders	setByte(CharSequence name, byte value) Set the name to value.
StompHeaders	setChar(CharSequence name, char value) Set the name to value.
StompHeaders	setDouble(CharSequence name, double value) Set the name to value.
StompHeaders	setFloat(CharSequence name, float value) Set the name to value.
StompHeaders	setInt(CharSequence name, int value) Set the name to value.
StompHeaders	setLong(CharSequence name, long value) Set the name to value.
StompHeaders	setObject(CharSequence name, Iterable<?> values) Sets a header with the specified name and values.
StompHeaders	setObject(CharSequence name, Object... values) Sets a header with the specified name and values.
StompHeaders	setObject(CharSequence name, Object value) Sets a new header.
StompHeaders	setShort(CharSequence name, short value) Set the name to value.
StompHeaders	setTimeMillis(CharSequence name, long value) Set the name to value.

Methods inherited from class io.netty.handler.codec.DefaultHeaders

contains, contains, containsBoolean, containsByte, containsChar, containsDouble, containsFloat, containsInt, containsLong, containsObject, containsShort, containsTimeMillis, equals, equals, get, get, getAll, getAllAndRemove, getAndRemove, getAndRemove, getBoolean, getBoolean, getBooleanAndRemove, getBooleanAndRemove, getByte, getByte, getByteAndRemove, getByteAndRemove, getChar, getChar, getCharAndRemove, getCharAndRemove, getDouble, getDouble, getDoubleAndRemove, getDoubleAndRemove, getFloat, getFloat, getFloatAndRemove, getFloatAndRemove, getInt, getInt, getIntAndRemove, getIntAndRemove, getLong, getLong, getLongAndRemove, getLongAndRemove, getShort, getShort, getShortAndRemove, getShortAndRemove, getTimeMillis, getTimeMillis, getTimeMillisAndRemove, getTimeMillisAndRemove, hashCode, hashCode, isEmpty, iterator, names, newHeaderEntry, remove, size, toString, valueConverter

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.handler.codec.Headers

contains, containsBoolean, containsByte, containsChar, containsDouble, containsFloat, containsInt, containsLong, containsObject, containsShort, containsTimeMillis, get, get, getAll, getAllAndRemove, getAndRemove, getAndRemove, getBoolean, getBoolean, getBooleanAndRemove, getBooleanAndRemove, getByte, getByte, getByteAndRemove, getByteAndRemove, getChar, getChar, getCharAndRemove, getCharAndRemove, getDouble, getDouble, getDoubleAndRemove, getDoubleAndRemove, getFloat, getFloat, getFloatAndRemove, getFloatAndRemove, getInt, getInt, getIntAndRemove, getIntAndRemove, getLong, getLong, getLongAndRemove, getLongAndRemove, getShort, getShort, getShortAndRemove, getShortAndRemove, getTimeMillis, getTimeMillis, getTimeMillisAndRemove, getTimeMillisAndRemove, isEmpty, iterator, names, remove, size

Constructor Detail

DefaultStompHeaders

public DefaultStompHeaders()

Method Detail

add

public StompHeaders add(CharSequence name,
               CharSequence value)

Description copied from interface: Headers

Adds a new header with the specified name and value.

Specified by:

add in interface Headers<CharSequence>

Specified by:

add in interface StompHeaders

Overrides:

add in class DefaultHeaders<CharSequence>

Parameters:

name - the name of the header

value - the value of the header

Returns:

this

add

public StompHeaders add(CharSequence name,
               Iterable<? extends CharSequence> values)

Description copied from interface: Headers

Adds new headers with the specified name and values. This method is semantically equivalent to

 for (T value : values) {
     headers.add(name, value);
 }
 

Specified by:

add in interface Headers<CharSequence>

Specified by:

add in interface StompHeaders

Overrides:

add in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

values - the values of the header

Returns:

this

add

public StompHeaders add(CharSequence name,
               CharSequence... values)

Description copied from interface: Headers

Adds new headers with the specified name and values. This method is semantically equivalent to

 for (T value : values) {
     headers.add(name, value);
 }
 

Specified by:

add in interface Headers<CharSequence>

Specified by:

add in interface StompHeaders

Overrides:

add in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

values - the values of the header

Returns:

this

addObject

public StompHeaders addObject(CharSequence name,
                     Object value)

Description copied from interface: Headers

Adds a new header. Before the value is added, it's converted to type T.

Specified by:

addObject in interface Headers<CharSequence>

Specified by:

addObject in interface StompHeaders

Overrides:

addObject in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

addObject

public StompHeaders addObject(CharSequence name,
                     Iterable<?> values)

Description copied from interface: Headers

Adds a new header with the specified name and values. This method is equivalent to

 for (Object v : values) {
     headers.addObject(name, v);
 }
 

Specified by:

addObject in interface Headers<CharSequence>

Specified by:

addObject in interface StompHeaders

Overrides:

addObject in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

values - the value of the header

Returns:

this

addObject

public StompHeaders addObject(CharSequence name,
                     Object... values)

Description copied from interface: Headers

Adds a new header with the specified name and values. This method is equivalent to

 for (Object v : values) {
     headers.addObject(name, v);
 }
 

Specified by:

addObject in interface Headers<CharSequence>

Specified by:

addObject in interface StompHeaders

Overrides:

addObject in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

values - the value of the header

Returns:

this

addBoolean

public StompHeaders addBoolean(CharSequence name,
                      boolean value)

Description copied from interface: Headers

Adds a new header.

Specified by:

addBoolean in interface Headers<CharSequence>

Specified by:

addBoolean in interface StompHeaders

Overrides:

addBoolean in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

addChar

public StompHeaders addChar(CharSequence name,
                   char value)

Description copied from interface: Headers

Adds a new header.

Specified by:

addChar in interface Headers<CharSequence>

Specified by:

addChar in interface StompHeaders

Overrides:

addChar in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

addByte

public StompHeaders addByte(CharSequence name,
                   byte value)

Description copied from interface: Headers

Adds a new header.

Specified by:

addByte in interface Headers<CharSequence>

Specified by:

addByte in interface StompHeaders

Overrides:

addByte in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

addShort

public StompHeaders addShort(CharSequence name,
                    short value)

Description copied from interface: Headers

Adds a new header.

Specified by:

addShort in interface Headers<CharSequence>

Specified by:

addShort in interface StompHeaders

Overrides:

addShort in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

addInt

public StompHeaders addInt(CharSequence name,
                  int value)

Description copied from interface: Headers

Adds a new header.

Specified by:

addInt in interface Headers<CharSequence>

Specified by:

addInt in interface StompHeaders

Overrides:

addInt in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

addLong

public StompHeaders addLong(CharSequence name,
                   long value)

Description copied from interface: Headers

Adds a new header.

Specified by:

addLong in interface Headers<CharSequence>

Specified by:

addLong in interface StompHeaders

Overrides:

addLong in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

addFloat

public StompHeaders addFloat(CharSequence name,
                    float value)

Description copied from interface: Headers

Adds a new header.

Specified by:

addFloat in interface Headers<CharSequence>

Specified by:

addFloat in interface StompHeaders

Overrides:

addFloat in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

addDouble

public StompHeaders addDouble(CharSequence name,
                     double value)

Description copied from interface: Headers

Adds a new header.

Specified by:

addDouble in interface Headers<CharSequence>

Specified by:

addDouble in interface StompHeaders

Overrides:

addDouble in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

addTimeMillis

public StompHeaders addTimeMillis(CharSequence name,
                         long value)

Description copied from interface: Headers

Adds a new header.

Specified by:

addTimeMillis in interface Headers<CharSequence>

Specified by:

addTimeMillis in interface StompHeaders

Overrides:

addTimeMillis in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

add

public StompHeaders add(Headers<? extends CharSequence> headers)

Description copied from interface: Headers

Adds all header names and values of headers to this object.

Specified by:

add in interface Headers<CharSequence>

Specified by:

add in interface StompHeaders

Overrides:

add in class DefaultHeaders<CharSequence>

Returns:

this

set

public StompHeaders set(CharSequence name,
               CharSequence value)

Description copied from interface: Headers

Sets a header with the specified name and value. Any existing headers with the same name are overwritten.

Specified by:

set in interface Headers<CharSequence>

Specified by:

set in interface StompHeaders

Overrides:

set in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

set

public StompHeaders set(CharSequence name,
               Iterable<? extends CharSequence> values)

Description copied from interface: Headers

Sets a new header with the specified name and values. This method is equivalent to

 for (T v : values) {
     headers.addObject(name, v);
 }
 

Specified by:

set in interface Headers<CharSequence>

Specified by:

set in interface StompHeaders

Overrides:

set in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

values - the value of the header

Returns:

this

set

public StompHeaders set(CharSequence name,
               CharSequence... values)

Description copied from interface: Headers

Sets a header with the specified name and values. Any existing headers with this name are removed. This method is equivalent to:

 headers.remove(name);
 for (T v : values) {
     headers.add(name, v);
 }
 

Specified by:

set in interface Headers<CharSequence>

Specified by:

set in interface StompHeaders

Overrides:

set in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

values - the value of the header

Returns:

this

setObject

public StompHeaders setObject(CharSequence name,
                     Object value)

Description copied from interface: Headers

Sets a new header. Any existing headers with this name are removed. Before the value is add, it's converted to type T.

Specified by:

setObject in interface Headers<CharSequence>

Specified by:

setObject in interface StompHeaders

Overrides:

setObject in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

setObject

public StompHeaders setObject(CharSequence name,
                     Iterable<?> values)

Description copied from interface: Headers

Sets a header with the specified name and values. Any existing headers with this name are removed. This method is equivalent to:

 headers.remove(name);
 for (Object v : values) {
     headers.addObject(name, v);
 }
 

Specified by:

setObject in interface Headers<CharSequence>

Specified by:

setObject in interface StompHeaders

Overrides:

setObject in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

values - the values of the header

Returns:

this

setObject

public StompHeaders setObject(CharSequence name,
                     Object... values)

Description copied from interface: Headers

Sets a header with the specified name and values. Any existing headers with this name are removed. This method is equivalent to:

 headers.remove(name);
 for (Object v : values) {
     headers.addObject(name, v);
 }
 

Specified by:

setObject in interface Headers<CharSequence>

Specified by:

setObject in interface StompHeaders

Overrides:

setObject in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

values - the values of the header

Returns:

this

setBoolean

public StompHeaders setBoolean(CharSequence name,
                      boolean value)

Description copied from interface: Headers

Set the name to value. This will remove all previous values associated with name.

Specified by:

setBoolean in interface Headers<CharSequence>

Specified by:

setBoolean in interface StompHeaders

Overrides:

setBoolean in class DefaultHeaders<CharSequence>

Parameters:

name - The name to modify

value - The value

Returns:

this

setChar

public StompHeaders setChar(CharSequence name,
                   char value)

Description copied from interface: Headers

Set the name to value. This will remove all previous values associated with name.

Specified by:

setChar in interface Headers<CharSequence>

Specified by:

setChar in interface StompHeaders

Overrides:

setChar in class DefaultHeaders<CharSequence>

Parameters:

name - The name to modify

value - The value

Returns:

this

setByte

public StompHeaders setByte(CharSequence name,
                   byte value)

Description copied from interface: Headers

Set the name to value. This will remove all previous values associated with name.

Specified by:

setByte in interface Headers<CharSequence>

Specified by:

setByte in interface StompHeaders

Overrides:

setByte in class DefaultHeaders<CharSequence>

Parameters:

name - The name to modify

value - The value

Returns:

this

setShort

public StompHeaders setShort(CharSequence name,
                    short value)

Description copied from interface: Headers

Set the name to value. This will remove all previous values associated with name.

Specified by:

setShort in interface Headers<CharSequence>

Specified by:

setShort in interface StompHeaders

Overrides:

setShort in class DefaultHeaders<CharSequence>

Parameters:

name - The name to modify

value - The value

Returns:

this

setInt

public StompHeaders setInt(CharSequence name,
                  int value)

Description copied from interface: Headers

Set the name to value. This will remove all previous values associated with name.

Specified by:

setInt in interface Headers<CharSequence>

Specified by:

setInt in interface StompHeaders

Overrides:

setInt in class DefaultHeaders<CharSequence>

Parameters:

name - The name to modify

value - The value

Returns:

this

setLong

public StompHeaders setLong(CharSequence name,
                   long value)

Description copied from interface: Headers

Set the name to value. This will remove all previous values associated with name.

Specified by:

setLong in interface Headers<CharSequence>

Specified by:

setLong in interface StompHeaders

Overrides:

setLong in class DefaultHeaders<CharSequence>

Parameters:

name - The name to modify

value - The value

Returns:

this

setFloat

public StompHeaders setFloat(CharSequence name,
                    float value)

Description copied from interface: Headers

Set the name to value. This will remove all previous values associated with name.

Specified by:

setFloat in interface Headers<CharSequence>

Specified by:

setFloat in interface StompHeaders

Overrides:

setFloat in class DefaultHeaders<CharSequence>

Parameters:

name - The name to modify

value - The value

Returns:

this

setDouble

public StompHeaders setDouble(CharSequence name,
                     double value)

Description copied from interface: Headers

Set the name to value. This will remove all previous values associated with name.

Specified by:

setDouble in interface Headers<CharSequence>

Specified by:

setDouble in interface StompHeaders

Overrides:

setDouble in class DefaultHeaders<CharSequence>

Parameters:

name - The name to modify

value - The value

Returns:

this

setTimeMillis

public StompHeaders setTimeMillis(CharSequence name,
                         long value)

Description copied from interface: Headers

Set the name to value. This will remove all previous values associated with name.

Specified by:

setTimeMillis in interface Headers<CharSequence>

Specified by:

setTimeMillis in interface StompHeaders

Overrides:

setTimeMillis in class DefaultHeaders<CharSequence>

Parameters:

name - The name to modify

value - The value

Returns:

this

set

public StompHeaders set(Headers<? extends CharSequence> headers)

Description copied from interface: Headers

Clears the current header entries and copies all header entries of the specified headers.

Specified by:

set in interface Headers<CharSequence>

Specified by:

set in interface StompHeaders

Overrides:

set in class DefaultHeaders<CharSequence>

Returns:

this

setAll

public StompHeaders setAll(Headers<? extends CharSequence> headers)

Description copied from interface: Headers

Retains all current headers but calls #set(T, T) for each entry in headers.

Specified by:

setAll in interface Headers<CharSequence>

Specified by:

setAll in interface StompHeaders

Overrides:

setAll in class DefaultHeaders<CharSequence>

Parameters:

headers - The headers used to #set(T, T) values in this instance

Returns:

this

clear

public StompHeaders clear()

Description copied from interface: Headers

Removes all headers. After a call to this method Headers.size() equals 0.

Specified by:

clear in interface Headers<CharSequence>

Specified by:

clear in interface StompHeaders

Overrides:

clear in class DefaultHeaders<CharSequence>

Returns:

this

getAsString

public String getAsString(CharSequence name)

Description copied from interface: StompHeaders

Headers.get(Object) and convert the result to a String.

Specified by:

getAsString in interface StompHeaders

Parameters:

name - the name of the header to retrieve

Returns:

the first header value if the header is found. null if there's no such header.

getAllAsString

public List<String> getAllAsString(CharSequence name)

Description copied from interface: StompHeaders

Headers.getAll(Object) and convert each element of List to a String.

Specified by:

getAllAsString in interface StompHeaders

Parameters:

name - the name of the header to retrieve

Returns:

a List of header values or an empty List if no values are found.

iteratorAsString

public Iterator<Map.Entry<String,String>> iteratorAsString()

Description copied from interface: StompHeaders

Headers.iterator() that converts each Map.Entry's key and value to a String.

Specified by:

iteratorAsString in interface StompHeaders

contains

public boolean contains(CharSequence name,
               CharSequence value)

Description copied from interface: Headers

Returns true if a header with the name and value exists, false otherwise.

The Object.equals(Object) method is used to test for equality of value.

Specified by:

contains in interface Headers<CharSequence>

Overrides:

contains in class DefaultHeaders<CharSequence>

Parameters:

name - the header name

value - the header value of the header to find

contains

public boolean contains(CharSequence name,
               CharSequence value,
               boolean ignoreCase)

Description copied from interface: StompHeaders

Returns true if a header with the name and value exists, false otherwise.

If ignoreCase is true then a case insensitive compare is done on the value.

Specified by:

contains in interface StompHeaders

Parameters:

name - the name of the header to find

value - the value of the header to find

ignoreCase - true then a case insensitive compare is run to compare values. otherwise a case sensitive compare is run to compare values.