Class DefaultStompHeaders

java.lang.Object

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

io.netty.handler.codec.stomp.DefaultStompHeaders

All Implemented Interfaces:

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

public class DefaultStompHeaders
extends DefaultHeaders<CharSequence, CharSequence, StompHeaders>
implements StompHeaders

Nested Class Summary

Nested classes/interfaces inherited from class DefaultHeaders

DefaultHeaders.HeaderEntry<K,V>, DefaultHeaders.NameValidator<K>, DefaultHeaders.ValueValidator<V>

Modifier and Type	Class	Description
protected static class	DefaultHeaders.HeaderEntry<K,V>
static interface	DefaultHeaders.NameValidator<K>
static interface	DefaultHeaders.ValueValidator<V>

Field Summary

Fields inherited from class DefaultHeaders

head

Modifier and Type	Field	Description
protected final DefaultHeaders.HeaderEntry<CharSequence, CharSequence>	head

Fields inherited from interface 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

Modifier and Type	Field	Description
static final AsciiString	ACCEPT_VERSION
static final AsciiString	ACK
static final AsciiString	CONTENT_LENGTH
static final AsciiString	CONTENT_TYPE
static final AsciiString	DESTINATION
static final AsciiString	HEART_BEAT
static final AsciiString	HOST
static final AsciiString	ID
static final AsciiString	LOGIN
static final AsciiString	MESSAGE
static final AsciiString	MESSAGE_ID
static final AsciiString	PASSCODE
static final AsciiString	RECEIPT
static final AsciiString	RECEIPT_ID
static final AsciiString	SERVER
static final AsciiString	SESSION
static final AsciiString	SUBSCRIPTION
static final AsciiString	TRANSACTION
static final AsciiString	VERSION

Constructor Summary

Constructors

Constructor	Description
DefaultStompHeaders()

Method Summary

Modifier and Type	Method	Description
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.
DefaultStompHeaders	copy()	Returns a deep copy of this instance.
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.

Methods inherited from class DefaultHeaders

add, add, add, add, addBoolean, addByte, addChar, addDouble, addFloat, addImpl, addInt, addLong, addObject, addObject, addObject, addShort, addTimeMillis, clear, 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, nameValidator, newHeaderEntry, remove, set, set, set, set, setAll, setBoolean, setByte, setChar, setDouble, setFloat, setInt, setLong, setObject, setObject, setObject, setShort, setTimeMillis, size, toString, validateName, validateValue, valueConverter, valueIterator, valueValidator

Modifier and Type	Method	Description
StompHeaders	add(Headers<? extends CharSequence, ? extends CharSequence, ?> headers)	Adds all header names and values of headers to this object.
StompHeaders	add(CharSequence name, Iterable<? extends 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, CharSequence... values)	Adds new headers with the specified name and values.
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.
protected void	addImpl(Headers<? extends CharSequence, ? extends CharSequence, ?> headers)
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 value)	Adds a new header.
StompHeaders	addObject(CharSequence name, Object... values)	Adds a new header with the specified name and values.
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)	Returns true if a header with the name exists, false otherwise.
final boolean	contains(CharSequence name, CharSequence value, HashingStrategy<? super CharSequence> valueHashingStrategy)
boolean	containsBoolean(CharSequence name, boolean value)	Returns true if a header with the name and value exists.
boolean	containsByte(CharSequence name, byte value)	Returns true if a header with the name and value exists.
boolean	containsChar(CharSequence name, char value)	Returns true if a header with the name and value exists.
boolean	containsDouble(CharSequence name, double value)	Returns true if a header with the name and value exists.
boolean	containsFloat(CharSequence name, float value)	Returns true if a header with the name and value exists.
boolean	containsInt(CharSequence name, int value)	Returns true if a header with the name and value exists.
boolean	containsLong(CharSequence name, long value)	Returns true if a header with the name and value exists.
boolean	containsObject(CharSequence name, Object value)	Returns true if a header with the name and value exists.
boolean	containsShort(CharSequence name, short value)	Returns true if a header with the name and value exists.
boolean	containsTimeMillis(CharSequence name, long value)	Returns true if a header with the name and value exists.
final boolean	equals(Headers<CharSequence, CharSequence, ?> h2, HashingStrategy<CharSequence> valueHashingStrategy)	Test this object for equality against h2.
boolean	equals(Object o)
CharSequence	get(CharSequence name)	Returns the value of a header with the specified name.
CharSequence	get(CharSequence name, CharSequence defaultValue)	Returns the value of a header with the specified name.
List<CharSequence>	getAll(CharSequence name)	Returns all values for the header with the specified name.
List<CharSequence>	getAllAndRemove(CharSequence name)	Returns all values for the header with the specified name and removes them from this object.
CharSequence	getAndRemove(CharSequence name)	Returns the value of a header with the specified name and removes it from this object.
CharSequence	getAndRemove(CharSequence name, CharSequence defaultValue)	Returns the value of a header with the specified name and removes it from this object.
Boolean	getBoolean(CharSequence name)	Returns the boolean value of a header with the specified name.
boolean	getBoolean(CharSequence name, boolean defaultValue)	Returns the boolean value of a header with the specified name.
Boolean	getBooleanAndRemove(CharSequence name)	Returns the boolean value of a header with the specified name and removes the header from this object.
boolean	getBooleanAndRemove(CharSequence name, boolean defaultValue)	Returns the boolean value of a header with the specified name and removes the header from this object.
Byte	getByte(CharSequence name)	Returns the byte value of a header with the specified name.
byte	getByte(CharSequence name, byte defaultValue)	Returns the byte value of a header with the specified name.
Byte	getByteAndRemove(CharSequence name)	Returns the byte value of a header with the specified name and removes the header from this object.
byte	getByteAndRemove(CharSequence name, byte defaultValue)	Returns the byte value of a header with the specified name and removes the header from this object.
Character	getChar(CharSequence name)	Returns the char value of a header with the specified name.
char	getChar(CharSequence name, char defaultValue)	Returns the char value of a header with the specified name.
Character	getCharAndRemove(CharSequence name)	Returns the char value of a header with the specified name and removes the header from this object.
char	getCharAndRemove(CharSequence name, char defaultValue)	Returns the char value of a header with the specified name and removes the header from this object.
Double	getDouble(CharSequence name)	Returns the double value of a header with the specified name.
double	getDouble(CharSequence name, double defaultValue)	Returns the double value of a header with the specified name.
Double	getDoubleAndRemove(CharSequence name)	Returns the double value of a header with the specified name and removes the header from this object.
double	getDoubleAndRemove(CharSequence name, double defaultValue)	Returns the double value of a header with the specified name and removes the header from this object.
Float	getFloat(CharSequence name)	Returns the float value of a header with the specified name.
float	getFloat(CharSequence name, float defaultValue)	Returns the float value of a header with the specified name.
Float	getFloatAndRemove(CharSequence name)	Returns the float value of a header with the specified name and removes the header from this object.
float	getFloatAndRemove(CharSequence name, float defaultValue)	Returns the float value of a header with the specified name and removes the header from this object.
Integer	getInt(CharSequence name)	Returns the int value of a header with the specified name.
int	getInt(CharSequence name, int defaultValue)	Returns the int value of a header with the specified name.
Integer	getIntAndRemove(CharSequence name)	Returns the int value of a header with the specified name and removes the header from this object.
int	getIntAndRemove(CharSequence name, int defaultValue)	Returns the int value of a header with the specified name and removes the header from this object.
Long	getLong(CharSequence name)	Returns the long value of a header with the specified name.
long	getLong(CharSequence name, long defaultValue)	Returns the long value of a header with the specified name.
Long	getLongAndRemove(CharSequence name)	Returns the long value of a header with the specified name and removes the header from this object.
long	getLongAndRemove(CharSequence name, long defaultValue)	Returns the long value of a header with the specified name and removes the header from this object.
Short	getShort(CharSequence name)	Returns the short value of a header with the specified name.
short	getShort(CharSequence name, short defaultValue)	Returns the short value of a header with the specified name.
Short	getShortAndRemove(CharSequence name)	Returns the short value of a header with the specified name and removes the header from this object.
short	getShortAndRemove(CharSequence name, short defaultValue)	Returns the short value of a header with the specified name and removes the header from this object.
Long	getTimeMillis(CharSequence name)	Returns the value of a header with the specified name in milliseconds.
long	getTimeMillis(CharSequence name, long defaultValue)	Returns the value of a header with the specified name in milliseconds.
Long	getTimeMillisAndRemove(CharSequence name)	Returns the value of a header with the specified name in milliseconds and removes the header from this object.
long	getTimeMillisAndRemove(CharSequence name, long defaultValue)	Returns the value of a header with the specified name in milliseconds and removes the header from this object.
int	hashCode()
final int	hashCode(HashingStrategy<CharSequence> valueHashingStrategy)	Generate a hash code for this object given a HashingStrategy to generate hash codes for individual values.
boolean	isEmpty()	Returns true if Headers.size() equals 0.
Iterator<Map.Entry<CharSequence, CharSequence>>	iterator()
Set<CharSequence>	names()	Returns a Set of all header names in this object.
protected DefaultHeaders.NameValidator<CharSequence>	nameValidator()
protected DefaultHeaders.HeaderEntry<CharSequence, CharSequence>	newHeaderEntry(int h, CharSequence name, CharSequence value, DefaultHeaders.HeaderEntry<CharSequence, CharSequence> next)
boolean	remove(CharSequence name)	Removes all headers with the specified name.
StompHeaders	set(Headers<? extends CharSequence, ? extends CharSequence, ?> headers)	Clears the current header entries and copies all header entries of the specified headers.
StompHeaders	set(CharSequence name, Iterable<? extends CharSequence> values)	Sets a new 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, CharSequence... values)	Sets a header with the specified name and values.
StompHeaders	setAll(Headers<? extends CharSequence, ? extends CharSequence, ?> headers)	Retains all current headers but calls Headers.set(K, V) 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 value)	Sets a new header.
StompHeaders	setObject(CharSequence name, Object... values)	Sets a header with the specified name and values.
StompHeaders	setShort(CharSequence name, short value)	Set the name to value.
StompHeaders	setTimeMillis(CharSequence name, long value)	Set the name to value.
int	size()	Returns the number of headers in this object.
String	toString()
protected void	validateName(DefaultHeaders.NameValidator<CharSequence> validator, boolean forAdd, CharSequence name)	Call out to the given DefaultHeaders.NameValidator to validate the given name.
protected void	validateValue(DefaultHeaders.ValueValidator<CharSequence> validator, CharSequence name, CharSequence value)
protected ValueConverter<CharSequence>	valueConverter()
Iterator<CharSequence>	valueIterator(CharSequence name)	Equivalent to DefaultHeaders.getAll(Object) but no intermediate list is generated.
protected DefaultHeaders.ValueValidator<CharSequence>	valueValidator()

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

DefaultStompHeaders

public DefaultStompHeaders()

Method Details

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, CharSequence, StompHeaders>

Overrides:

contains in class DefaultHeaders<CharSequence, CharSequence, StompHeaders>

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.

copy

public DefaultStompHeaders copy()

Description copied from class: DefaultHeaders

Returns a deep copy of this instance.

Overrides:

copy in class DefaultHeaders<CharSequence, CharSequence, StompHeaders>