Package org.cometd.bayeux

Interface Message.Mutable

All Superinterfaces:

Map<String,Object>, Message

All Known Subinterfaces:

ServerMessage.Mutable

All Known Implementing Classes:

HashMapMessage, ServerMessageImpl

Enclosing interface:

Message

public static interface Message.Mutable
extends Message

The mutable version of a Message

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface org.cometd.bayeux.Message

Message.Mutable

Field Summary

Fields inherited from interface org.cometd.bayeux.Message

ADVICE_FIELD, CHANNEL_FIELD, CLIENT_ID_FIELD, CONNECTION_TYPE_FIELD, DATA_FIELD, ERROR_FIELD, EXT_FIELD, ID_FIELD, INTERVAL_FIELD, MAX_INTERVAL_FIELD, MIN_VERSION_FIELD, RECONNECT_FIELD, RECONNECT_HANDSHAKE_VALUE, RECONNECT_NONE_VALUE, RECONNECT_RETRY_VALUE, SUBSCRIPTION_FIELD, SUCCESSFUL_FIELD, SUPPORTED_CONNECTION_TYPES_FIELD, TIMEOUT_FIELD, TIMESTAMP_FIELD, TRANSPORT_FIELD, VERSION_FIELD

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAdvice(boolean create)	Convenience method to retrieve the Message.ADVICE_FIELD and create it if it does not exist
Map<String,Object>	getDataAsMap(boolean create)	Convenience method to retrieve the Message.DATA_FIELD and create it if it does not exist
Map<String,Object>	getExt(boolean create)	Convenience method to retrieve the Message.EXT_FIELD and create it if it does not exist
void	setChannel(String channel)
void	setClientId(String clientId)
void	setData(Object data)
void	setId(String id)
void	setSuccessful(boolean successful)

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from interface org.cometd.bayeux.Message

getAdvice, getChannel, getChannelId, getClientId, getData, getDataAsMap, getExt, getId, getJSON, isMeta, isPublishReply, isSuccessful

Method Details

getAdvice

Map<String,Object> getAdvice(boolean create)

Convenience method to retrieve the Message.ADVICE_FIELD and create it if it does not exist

Parameters:

create - whether to create the advice field if it does not exist

Returns:

the advice of the message

getDataAsMap

Map<String,Object> getDataAsMap(boolean create)

Convenience method to retrieve the Message.DATA_FIELD and create it if it does not exist

Parameters:

create - whether to create the data field if it does not exist

Returns:

the data of the message

getExt

Map<String,Object> getExt(boolean create)

Convenience method to retrieve the Message.EXT_FIELD and create it if it does not exist

Parameters:

create - whether to create the ext field if it does not exist

Returns:

the ext of the message

setChannel

void setChannel(String channel)

Parameters:

channel - the channel of this message

setClientId

void setClientId(String clientId)

Parameters:

clientId - the client id of this message

setData

void setData(Object data)

Parameters:

data - the data of this message

setId

void setId(String id)

Parameters:

id - the id of this message

setSuccessful

void setSuccessful(boolean successful)

Parameters:

successful - the successfulness of this message