io.netty.handler.codec.stomp

Interface StompHeaders

All Superinterfaces:

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

All Known Implementing Classes:

DefaultStompHeaders

public interface StompHeaders
extends Headers<CharSequence,CharSequence,StompHeaders>

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

Modifier and Type	Method and Description
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.

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

add, add, add, add, addBoolean, addByte, addChar, addDouble, addFloat, addInt, addLong, addObject, addObject, addObject, addShort, addTimeMillis, clear, 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, set, set, set, set, setAll, setBoolean, setByte, setChar, setDouble, setFloat, setInt, setLong, setObject, setObject, setObject, setShort, setTimeMillis, size

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

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.