StompHeaders (Netty API Reference (5.0.0.Alpha2))

All Superinterfaces:

ConvertibleHeaders<CharSequence,String>, Headers<CharSequence>, Iterable<Map.Entry<CharSequence,CharSequence>>, TextHeaders

All Known Implementing Classes:

DefaultStompHeaders
```
public interface StompHeaders
extends TextHeaders
```
The multimap data structure for the STOMP header names and values. It also provides the constants for the standard STOMP header names and values.

Nested Class Summary
- Nested classes/interfaces inherited from interface io.netty.handler.codec.TextHeaders
  TextHeaders.EntryVisitor, TextHeaders.NameVisitor
- Nested classes/interfaces inherited from interface io.netty.handler.codec.ConvertibleHeaders
  ConvertibleHeaders.TypeConverter<UnconvertedType,ConvertedType>
- Nested classes/interfaces inherited from interface io.netty.handler.codec.Headers
  Headers.ValueConverter<T>

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 a new header 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 a new header with the specified name and values.
`StompHeaders`	`add(TextHeaders headers)` See `Headers.add(Headers)`
`StompHeaders`	`addBoolean(CharSequence name, boolean value)` Add the `name` to `value`.
`StompHeaders`	`addByte(CharSequence name, byte value)` Add the `name` to `value`.
`StompHeaders`	`addChar(CharSequence name, char value)` Add the `name` to `value`.
`StompHeaders`	`addDouble(CharSequence name, double value)` Add the `name` to `value`.
`StompHeaders`	`addFloat(CharSequence name, float value)` Add the `name` to `value`.
`StompHeaders`	`addInt(CharSequence name, int value)` Add the `name` to `value`.
`StompHeaders`	`addLong(CharSequence name, long value)` Add the `name` to `value`.
`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 with the specified name and value.
`StompHeaders`	`addShort(CharSequence name, short value)` Add the `name` to `value`.
`StompHeaders`	`addTimeMillis(CharSequence name, long value)` Add the `name` to `value`.
`StompHeaders`	`clear()` Removes all headers.
`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 header with the specified name and values.
`StompHeaders`	`set(TextHeaders headers)` See `Headers.set(Headers)`
`StompHeaders`	`setAll(TextHeaders headers)` See `Headers.setAll(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 header with the specified name and value.
`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.TextHeaders
contains, containsObject

Methods inherited from interface io.netty.handler.codec.ConvertibleHeaders
entriesConverted, getAllAndConvert, getAllAndRemoveAndConvert, getAndConvert, getAndConvert, getAndRemoveAndConvert, getAndRemoveAndConvert, iteratorConverted, namesAndConvert

Methods inherited from interface io.netty.handler.codec.Headers
add, contains, contains, contains, contains, containsBoolean, containsByte, containsChar, containsDouble, containsFloat, containsInt, containsLong, containsObject, containsObject, containsObject, containsShort, containsTimeMillis, entries, forEachEntry, forEachName, 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, getInt, getIntAndRemove, getIntAndRemove, getLong, getLong, getLongAndRemove, getLongAndRemove, getShort, getShortAndRemove, getShortAndRemove, getTimeMillis, getTimeMillis, getTimeMillisAndRemove, getTimeMillisAndRemove, isEmpty, iterator, names, namesList, remove, set, setAll, 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. If the specified value is not a String, it is converted into a String by Object.toString(), except in the cases of Date and Calendar, which are formatted to the date format defined in RFC2616.
    
    Specified by:
    
    add in interface Headers<CharSequence>
    
    Specified by:
    
    add in interface TextHeaders
    
    Parameters:
    name - the name of the header being added
    value - the value of the header being added
    
    Returns:
    this
  - add
```
StompHeaders add(CharSequence name,
               Iterable<? extends CharSequence> values)
```
    Description copied from interface: Headers
    Adds a new header with the specified name and values. This getMethod can be represented approximately as the following code:
```
 for (Object v : values) {
     if (v == null) {
         break;
     }
     headers.add(name, v);
 }
 
```
    Specified by:
    
    add in interface Headers<CharSequence>
    
    Specified by:
    
    add in interface TextHeaders
    
    Parameters:
    name - the name of the headepublic abstract rs being set
    values - the values of the headers being set
    
    Returns:
    this
  - add
```
StompHeaders add(CharSequence name,
               CharSequence... values)
```
    Description copied from interface: Headers
    Adds a new header with the specified name and values. This getMethod can be represented approximately as the following code:
```
 for (Object v : values) {
     if (v == null) {
         break;
     }
     headers.add(name, v);
 }
 
```
    Specified by:
    
    add in interface Headers<CharSequence>
    
    Specified by:
    
    add in interface TextHeaders
    
    Parameters:
    name - the name of the headepublic abstract rs being set
    values - the values of the headers being set
    
    Returns:
    this
  - addObject
```
StompHeaders addObject(CharSequence name,
                     Object value)
```
    Description copied from interface: Headers
    
    Adds a new header with the specified name and value. If the specified value is not a String, it is converted into a String by Object.toString(), except in the cases of Date and Calendar, which are formatted to the date format defined in RFC2616.
    
    Specified by:
    
    addObject in interface Headers<CharSequence>
    
    Specified by:
    
    addObject in interface TextHeaders
    
    Parameters:
    name - the name of the header being added
    value - the value of the header being added
    
    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 getMethod can be represented approximately as the following code:
```
 for (Object v : values) {
     if (v == null) {
         break;
     }
     headers.add(name, v);
 }
 
```
    Specified by:
    
    addObject in interface Headers<CharSequence>
    
    Specified by:
    
    addObject in interface TextHeaders
    
    Parameters:
    name - the name of the headepublic abstract rs being set
    values - the values of the headers being set
    
    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 getMethod can be represented approximately as the following code:
```
 for (Object v : values) {
     if (v == null) {
         break;
     }
     headers.add(name, v);
 }
 
```
    Specified by:
    
    addObject in interface Headers<CharSequence>
    
    Specified by:
    
    addObject in interface TextHeaders
    
    Parameters:
    name - the name of the headepublic abstract rs being set
    values - the values of the headers being set
    
    Returns:
    this
  - addBoolean
```
StompHeaders addBoolean(CharSequence name,
                      boolean value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addBoolean in interface Headers<CharSequence>
    
    Specified by:
    
    addBoolean in interface TextHeaders
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addByte
```
StompHeaders addByte(CharSequence name,
                   byte value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addByte in interface Headers<CharSequence>
    
    Specified by:
    
    addByte in interface TextHeaders
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addChar
```
StompHeaders addChar(CharSequence name,
                   char value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addChar in interface Headers<CharSequence>
    
    Specified by:
    
    addChar in interface TextHeaders
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addShort
```
StompHeaders addShort(CharSequence name,
                    short value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addShort in interface Headers<CharSequence>
    
    Specified by:
    
    addShort in interface TextHeaders
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addInt
```
StompHeaders addInt(CharSequence name,
                  int value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addInt in interface Headers<CharSequence>
    
    Specified by:
    
    addInt in interface TextHeaders
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addLong
```
StompHeaders addLong(CharSequence name,
                   long value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addLong in interface Headers<CharSequence>
    
    Specified by:
    
    addLong in interface TextHeaders
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addFloat
```
StompHeaders addFloat(CharSequence name,
                    float value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addFloat in interface Headers<CharSequence>
    
    Specified by:
    
    addFloat in interface TextHeaders
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addDouble
```
StompHeaders addDouble(CharSequence name,
                     double value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addDouble in interface Headers<CharSequence>
    
    Specified by:
    
    addDouble in interface TextHeaders
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addTimeMillis
```
StompHeaders addTimeMillis(CharSequence name,
                         long value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addTimeMillis in interface Headers<CharSequence>
    
    Specified by:
    
    addTimeMillis in interface TextHeaders
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - add
```
StompHeaders add(TextHeaders headers)
```
    Description copied from interface: TextHeaders
    
    See Headers.add(Headers)
    
    Specified by:
    
    add in interface TextHeaders
  - set
```
StompHeaders set(CharSequence name,
               CharSequence value)
```
    Description copied from interface: Headers
    
    Sets a header with the specified name and value. If there is an existing header with the same name, it is removed. If the specified value is not a String, it is converted into a String by Object.toString(), except for Date and Calendar, which are formatted to the date format defined in RFC2616.
    
    Specified by:
    
    set in interface Headers<CharSequence>
    
    Specified by:
    
    set in interface TextHeaders
    
    Parameters:
    name - The name of the header being set
    value - The value of the header being set
    
    Returns:
    this
  - set
```
StompHeaders set(CharSequence name,
               Iterable<? extends CharSequence> values)
```
    Description copied from interface: Headers
    Sets a header with the specified name and values. If there is an existing header with the same name, it is removed. This getMethod can be represented approximately as the following code:
```
 headers.remove(name);
 for (Object v : values) {
     if (v == null) {
         break;
     }
     headers.add(name, v);
 }
 
```
    Specified by:
    
    set in interface Headers<CharSequence>
    
    Specified by:
    
    set in interface TextHeaders
    
    Parameters:
    name - the name of the headers being set
    values - the values of the headers being set
    
    Returns:
    this
  - set
```
StompHeaders set(CharSequence name,
               CharSequence... values)
```
    Description copied from interface: Headers
    Sets a header with the specified name and values. If there is an existing header with the same name, it is removed. This getMethod can be represented approximately as the following code:
```
 headers.remove(name);
 for (Object v : values) {
     if (v == null) {
         break;
     }
     headers.add(name, v);
 }
 
```
    Specified by:
    
    set in interface Headers<CharSequence>
    
    Specified by:
    
    set in interface TextHeaders
    
    Parameters:
    name - the name of the headers being set
    values - the values of the headers being set
    
    Returns:
    this
  - setObject
```
StompHeaders setObject(CharSequence name,
                     Object value)
```
    Description copied from interface: Headers
    
    Sets a header with the specified name and value. If there is an existing header with the same name, it is removed. If the specified value is not a String, it is converted into a String by Object.toString(), except for Date and Calendar, which are formatted to the date format defined in RFC2616.
    
    Specified by:
    
    setObject in interface Headers<CharSequence>
    
    Specified by:
    
    setObject in interface TextHeaders
    
    Parameters:
    name - The name of the header being set
    value - The value of the header being set
    
    Returns:
    this
  - setObject
```
StompHeaders setObject(CharSequence name,
                     Iterable<?> values)
```
    Description copied from interface: Headers
    Sets a header with the specified name and values. If there is an existing header with the same name, it is removed. This getMethod can be represented approximately as the following code:
```
 headers.remove(name);
 for (Object v : values) {
     if (v == null) {
         break;
     }
     headers.add(name, v);
 }
 
```
    Specified by:
    
    setObject in interface Headers<CharSequence>
    
    Specified by:
    
    setObject in interface TextHeaders
    
    Parameters:
    name - the name of the headers being set
    values - the values of the headers being set
    
    Returns:
    this
  - setObject
```
StompHeaders setObject(CharSequence name,
                     Object... values)
```
    Description copied from interface: Headers
    Sets a header with the specified name and values. If there is an existing header with the same name, it is removed. This getMethod can be represented approximately as the following code:
```
 headers.remove(name);
 for (Object v : values) {
     if (v == null) {
         break;
     }
     headers.add(name, v);
 }
 
```
    Specified by:
    
    setObject in interface Headers<CharSequence>
    
    Specified by:
    
    setObject in interface TextHeaders
    
    Parameters:
    name - the name of the headers being set
    values - the values of the headers being set
    
    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>
    
    Specified by:
    
    setBoolean in interface TextHeaders
    
    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>
    
    Specified by:
    
    setByte in interface TextHeaders
    
    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>
    
    Specified by:
    
    setChar in interface TextHeaders
    
    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>
    
    Specified by:
    
    setShort in interface TextHeaders
    
    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>
    
    Specified by:
    
    setInt in interface TextHeaders
    
    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>
    
    Specified by:
    
    setLong in interface TextHeaders
    
    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>
    
    Specified by:
    
    setFloat in interface TextHeaders
    
    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>
    
    Specified by:
    
    setDouble in interface TextHeaders
    
    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>
    
    Specified by:
    
    setTimeMillis in interface TextHeaders
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - set
```
StompHeaders set(TextHeaders headers)
```
    Description copied from interface: TextHeaders
    
    See Headers.set(Headers)
    
    Specified by:
    
    set in interface TextHeaders
  - setAll
```
StompHeaders setAll(TextHeaders headers)
```
    Description copied from interface: TextHeaders
    
    See Headers.setAll(Headers)
    
    Specified by:
    
    setAll in interface TextHeaders
  - clear
```
StompHeaders clear()
```
    Description copied from interface: Headers
    
    Removes all headers.
    
    Specified by:
    
    clear in interface Headers<CharSequence>
    
    Specified by:
    
    clear in interface TextHeaders
    
    Returns:
    this

Interface StompHeaders

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.handler.codec.TextHeaders

Nested classes/interfaces inherited from interface io.netty.handler.codec.ConvertibleHeaders

Nested classes/interfaces inherited from interface io.netty.handler.codec.Headers

Field Summary

Method Summary

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

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

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

Field Detail

ACCEPT_VERSION

HOST

LOGIN

PASSCODE

HEART_BEAT

VERSION

SESSION

SERVER

DESTINATION

ID

ACK

TRANSACTION

RECEIPT

MESSAGE_ID

SUBSCRIPTION

RECEIPT_ID

MESSAGE

CONTENT_LENGTH

CONTENT_TYPE

Method Detail

add

add

add

addObject

addObject

addObject

addBoolean

addByte

addChar

addShort

addInt

addLong

addFloat

addDouble

addTimeMillis

add

set

set

set

setObject

setObject

setObject

setBoolean

setByte

setChar

setShort

setInt

setLong

setFloat

setDouble

setTimeMillis

set

setAll

clear