io.netty.handler.codec.stomp

Interface StompHeaders

All Superinterfaces:

io.netty.handler.codec.Headers<CharSequence>, Iterable<Map.Entry<CharSequence,CharSequence>>

All Known Implementing Classes:

DefaultStompHeaders

public interface StompHeaders
extends io.netty.handler.codec.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 io.netty.util.AsciiString	ACCEPT_VERSION
static io.netty.util.AsciiString	ACK
static io.netty.util.AsciiString	CONTENT_LENGTH
static io.netty.util.AsciiString	CONTENT_TYPE
static io.netty.util.AsciiString	DESTINATION
static io.netty.util.AsciiString	HEART_BEAT
static io.netty.util.AsciiString	HOST
static io.netty.util.AsciiString	ID
static io.netty.util.AsciiString	LOGIN
static io.netty.util.AsciiString	MESSAGE
static io.netty.util.AsciiString	MESSAGE_ID
static io.netty.util.AsciiString	PASSCODE
static io.netty.util.AsciiString	RECEIPT
static io.netty.util.AsciiString	RECEIPT_ID
static io.netty.util.AsciiString	SERVER
static io.netty.util.AsciiString	SESSION
static io.netty.util.AsciiString	SUBSCRIPTION
static io.netty.util.AsciiString	TRANSACTION
static io.netty.util.AsciiString	VERSION

Method Summary

Methods

Modifier and Type	Method and Description
StompHeaders	add(CharSequence name, CharSequence... values)
StompHeaders	add(CharSequence name, CharSequence value)
StompHeaders	add(CharSequence name, Iterable<? extends CharSequence> values)
StompHeaders	add(io.netty.handler.codec.Headers<? extends CharSequence> headers)
StompHeaders	addBoolean(CharSequence name, boolean value)
StompHeaders	addByte(CharSequence name, byte value)
StompHeaders	addChar(CharSequence name, char value)
StompHeaders	addDouble(CharSequence name, double value)
StompHeaders	addFloat(CharSequence name, float value)
StompHeaders	addInt(CharSequence name, int value)
StompHeaders	addLong(CharSequence name, long value)
StompHeaders	addObject(CharSequence name, Iterable<?> values)
StompHeaders	addObject(CharSequence name, Object... values)
StompHeaders	addObject(CharSequence name, Object value)
StompHeaders	addShort(CharSequence name, short value)
StompHeaders	addTimeMillis(CharSequence name, long value)
StompHeaders	clear()
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)
StompHeaders	set(CharSequence name, CharSequence value)
StompHeaders	set(CharSequence name, Iterable<? extends CharSequence> values)
StompHeaders	set(io.netty.handler.codec.Headers<? extends CharSequence> headers)
StompHeaders	setAll(io.netty.handler.codec.Headers<? extends CharSequence> headers)
StompHeaders	setBoolean(CharSequence name, boolean value)
StompHeaders	setByte(CharSequence name, byte value)
StompHeaders	setChar(CharSequence name, char value)
StompHeaders	setDouble(CharSequence name, double value)
StompHeaders	setFloat(CharSequence name, float value)
StompHeaders	setInt(CharSequence name, int value)
StompHeaders	setLong(CharSequence name, long value)
StompHeaders	setObject(CharSequence name, Iterable<?> values)
StompHeaders	setObject(CharSequence name, Object... values)
StompHeaders	setObject(CharSequence name, Object value)
StompHeaders	setShort(CharSequence name, short value)
StompHeaders	setTimeMillis(CharSequence name, long 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 io.netty.util.AsciiString ACCEPT_VERSION

HOST

static final io.netty.util.AsciiString HOST

LOGIN

static final io.netty.util.AsciiString LOGIN

PASSCODE

static final io.netty.util.AsciiString PASSCODE

HEART_BEAT

static final io.netty.util.AsciiString HEART_BEAT

VERSION

static final io.netty.util.AsciiString VERSION

SESSION

static final io.netty.util.AsciiString SESSION

SERVER

static final io.netty.util.AsciiString SERVER

DESTINATION

static final io.netty.util.AsciiString DESTINATION

ID

static final io.netty.util.AsciiString ID

ACK

static final io.netty.util.AsciiString ACK

TRANSACTION

static final io.netty.util.AsciiString TRANSACTION

RECEIPT

static final io.netty.util.AsciiString RECEIPT

MESSAGE_ID

static final io.netty.util.AsciiString MESSAGE_ID

SUBSCRIPTION

static final io.netty.util.AsciiString SUBSCRIPTION

RECEIPT_ID

static final io.netty.util.AsciiString RECEIPT_ID

MESSAGE

static final io.netty.util.AsciiString MESSAGE

CONTENT_LENGTH

static final io.netty.util.AsciiString CONTENT_LENGTH

CONTENT_TYPE

static final io.netty.util.AsciiString CONTENT_TYPE

Method Detail

add

StompHeaders add(CharSequence name,
               CharSequence value)

Specified by:

add in interface io.netty.handler.codec.Headers<CharSequence>

add

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

Specified by:

add in interface io.netty.handler.codec.Headers<CharSequence>

add

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

Specified by:

add in interface io.netty.handler.codec.Headers<CharSequence>

addObject

StompHeaders addObject(CharSequence name,
                     Object value)

Specified by:

addObject in interface io.netty.handler.codec.Headers<CharSequence>

addObject

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

Specified by:

addObject in interface io.netty.handler.codec.Headers<CharSequence>

addObject

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

Specified by:

addObject in interface io.netty.handler.codec.Headers<CharSequence>

addBoolean

StompHeaders addBoolean(CharSequence name,
                      boolean value)

Specified by:

addBoolean in interface io.netty.handler.codec.Headers<CharSequence>

addByte

StompHeaders addByte(CharSequence name,
                   byte value)

Specified by:

addByte in interface io.netty.handler.codec.Headers<CharSequence>

addChar

StompHeaders addChar(CharSequence name,
                   char value)

Specified by:

addChar in interface io.netty.handler.codec.Headers<CharSequence>

addShort

StompHeaders addShort(CharSequence name,
                    short value)

Specified by:

addShort in interface io.netty.handler.codec.Headers<CharSequence>

addInt

StompHeaders addInt(CharSequence name,
                  int value)

Specified by:

addInt in interface io.netty.handler.codec.Headers<CharSequence>

addLong

StompHeaders addLong(CharSequence name,
                   long value)

Specified by:

addLong in interface io.netty.handler.codec.Headers<CharSequence>

addFloat

StompHeaders addFloat(CharSequence name,
                    float value)

Specified by:

addFloat in interface io.netty.handler.codec.Headers<CharSequence>

addDouble

StompHeaders addDouble(CharSequence name,
                     double value)

Specified by:

addDouble in interface io.netty.handler.codec.Headers<CharSequence>

addTimeMillis

StompHeaders addTimeMillis(CharSequence name,
                         long value)

Specified by:

addTimeMillis in interface io.netty.handler.codec.Headers<CharSequence>

add

StompHeaders add(io.netty.handler.codec.Headers<? extends CharSequence> headers)

Specified by:

add in interface io.netty.handler.codec.Headers<CharSequence>

set

StompHeaders set(CharSequence name,
               CharSequence value)

Specified by:

set in interface io.netty.handler.codec.Headers<CharSequence>

set

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

Specified by:

set in interface io.netty.handler.codec.Headers<CharSequence>

set

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

Specified by:

set in interface io.netty.handler.codec.Headers<CharSequence>

setObject

StompHeaders setObject(CharSequence name,
                     Object value)

Specified by:

setObject in interface io.netty.handler.codec.Headers<CharSequence>

setObject

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

Specified by:

setObject in interface io.netty.handler.codec.Headers<CharSequence>

setObject

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

Specified by:

setObject in interface io.netty.handler.codec.Headers<CharSequence>

setBoolean

StompHeaders setBoolean(CharSequence name,
                      boolean value)

Specified by:

setBoolean in interface io.netty.handler.codec.Headers<CharSequence>

setByte

StompHeaders setByte(CharSequence name,
                   byte value)

Specified by:

setByte in interface io.netty.handler.codec.Headers<CharSequence>

setChar

StompHeaders setChar(CharSequence name,
                   char value)

Specified by:

setChar in interface io.netty.handler.codec.Headers<CharSequence>

setShort

StompHeaders setShort(CharSequence name,
                    short value)

Specified by:

setShort in interface io.netty.handler.codec.Headers<CharSequence>

setInt

StompHeaders setInt(CharSequence name,
                  int value)

Specified by:

setInt in interface io.netty.handler.codec.Headers<CharSequence>

setLong

StompHeaders setLong(CharSequence name,
                   long value)

Specified by:

setLong in interface io.netty.handler.codec.Headers<CharSequence>

setFloat

StompHeaders setFloat(CharSequence name,
                    float value)

Specified by:

setFloat in interface io.netty.handler.codec.Headers<CharSequence>

setDouble

StompHeaders setDouble(CharSequence name,
                     double value)

Specified by:

setDouble in interface io.netty.handler.codec.Headers<CharSequence>

setTimeMillis

StompHeaders setTimeMillis(CharSequence name,
                         long value)

Specified by:

setTimeMillis in interface io.netty.handler.codec.Headers<CharSequence>

set

StompHeaders set(io.netty.handler.codec.Headers<? extends CharSequence> headers)

Specified by:

set in interface io.netty.handler.codec.Headers<CharSequence>

setAll

StompHeaders setAll(io.netty.handler.codec.Headers<? extends CharSequence> headers)

Specified by:

setAll in interface io.netty.handler.codec.Headers<CharSequence>

clear

StompHeaders clear()

Specified by:

clear in interface io.netty.handler.codec.Headers<CharSequence>

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.