io.netty.handler.codec.stomp

Interface StompHeaders

All Superinterfaces:

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

All Known Implementing Classes:

DefaultStompHeaders

public interface StompHeaders
extends Headers<CharSequence>

The multimap data structure for the STOMP header names and values. It also provides the constants for the standard STOMP header names and values.

Field Summary

Fields

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

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, 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 interface io.netty.handler.codec.Headers

contains, 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

Field Detail

ACCEPT_VERSION

static final AsciiString ACCEPT_VERSION

HOST

static final AsciiString HOST

LOGIN

static final AsciiString LOGIN

PASSCODE

static final AsciiString PASSCODE

HEART_BEAT

static final AsciiString HEART_BEAT

VERSION

static final AsciiString VERSION

SESSION

static final AsciiString SESSION

SERVER

static final AsciiString SERVER

DESTINATION

static final AsciiString DESTINATION

ID

static final AsciiString ID

ACK

static final AsciiString ACK

TRANSACTION

static final AsciiString TRANSACTION

RECEIPT

static final AsciiString RECEIPT

MESSAGE_ID

static final AsciiString MESSAGE_ID

SUBSCRIPTION

static final AsciiString SUBSCRIPTION

RECEIPT_ID

static final AsciiString RECEIPT_ID

MESSAGE

static final AsciiString MESSAGE

CONTENT_LENGTH

static final AsciiString CONTENT_LENGTH

CONTENT_TYPE

static final AsciiString CONTENT_TYPE

Method Detail

add

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>

Parameters:

name - the name of the header

value - the value of the header

Returns:

this

add

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>

Parameters:

name - the header name

values - the values of the header

Returns:

this

add

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>

Parameters:

name - the header name

values - the values of the header

Returns:

this

addObject

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>

Parameters:

name - the header name

value - the value of the header

Returns:

this

addObject

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>

Parameters:

name - the header name

values - the value of the header

Returns:

this

addObject

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>

Parameters:

name - the header name

values - the value of the header

Returns:

this

addBoolean

StompHeaders addBoolean(CharSequence name,
                      boolean value)

Description copied from interface: Headers

Adds a new header.

Specified by:

addBoolean in interface Headers<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

addByte

StompHeaders addByte(CharSequence name,
                   byte value)

Description copied from interface: Headers

Adds a new header.

Specified by:

addByte in interface Headers<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

addChar

StompHeaders addChar(CharSequence name,
                   char value)

Description copied from interface: Headers

Adds a new header.

Specified by:

addChar in interface Headers<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

addShort

StompHeaders addShort(CharSequence name,
                    short value)

Description copied from interface: Headers

Adds a new header.

Specified by:

addShort in interface Headers<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

addInt

StompHeaders addInt(CharSequence name,
                  int value)

Description copied from interface: Headers

Adds a new header.

Specified by:

addInt in interface Headers<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

addLong

StompHeaders addLong(CharSequence name,
                   long value)

Description copied from interface: Headers

Adds a new header.

Specified by:

addLong in interface Headers<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

addFloat

StompHeaders addFloat(CharSequence name,
                    float value)

Description copied from interface: Headers

Adds a new header.

Specified by:

addFloat in interface Headers<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

addDouble

StompHeaders addDouble(CharSequence name,
                     double value)

Description copied from interface: Headers

Adds a new header.

Specified by:

addDouble in interface Headers<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

addTimeMillis

StompHeaders addTimeMillis(CharSequence name,
                         long value)

Description copied from interface: Headers

Adds a new header.

Specified by:

addTimeMillis in interface Headers<CharSequence>

Parameters:

name - the header name

value - the value of the header

Returns:

this

add

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>

Returns:

this

set

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>

Parameters:

name - the header name

value - the value of the header

Returns:

this

set

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>

Parameters:

name - the header name

values - the value of the header

Returns:

this

set

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>

Parameters:

name - the header name

values - the value of the header

Returns:

this

setObject

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>

Parameters:

name - the header name

value - the value of the header

Returns:

this

setObject

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>

Parameters:

name - the header name

values - the values of the header

Returns:

this

setObject

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>

Parameters:

name - the header name

values - the values of the header

Returns:

this

setBoolean

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>

Parameters:

name - The name to modify

value - The value

Returns:

this

setByte

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>

Parameters:

name - The name to modify

value - The value

Returns:

this

setChar

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>

Parameters:

name - The name to modify

value - The value

Returns:

this

setShort

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>

Parameters:

name - The name to modify

value - The value

Returns:

this

setInt

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>

Parameters:

name - The name to modify

value - The value

Returns:

this

setLong

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>

Parameters:

name - The name to modify

value - The value

Returns:

this

setFloat

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>

Parameters:

name - The name to modify

value - The value

Returns:

this

setDouble

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>

Parameters:

name - The name to modify

value - The value

Returns:

this

setTimeMillis

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>

Parameters:

name - The name to modify

value - The value

Returns:

this

set

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>

Returns:

this

setAll

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>

Parameters:

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

Returns:

this

clear

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>

Returns:

this

getAsString

String getAsString(CharSequence name)

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

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

List<String> getAllAsString(CharSequence name)

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

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

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

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

contains

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

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.

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.