public class Message extends SampMap
Modifier and Type | Field and Description |
---|---|
private static java.lang.String[] |
KNOWN_KEYS |
static java.lang.String |
MTYPE_KEY
Key for message MType.
|
static java.lang.String |
PARAMS_KEY
Key for map of parameters used by this message.
|
Constructor and Description |
---|
Message()
Constructs an empty message.
|
Message(java.util.Map map)
Constructs a message based on an existing map.
|
Message(java.lang.String mtype)
Constructs a message with a given MType.
|
Message(java.lang.String mtype,
java.util.Map params)
Constructs a message with a given MType and params map.
|
Modifier and Type | Method and Description |
---|---|
Message |
addParam(java.lang.String name,
java.lang.Object value)
Sets the value for a single entry in this message's
samp.params map. |
static Message |
asMessage(java.util.Map map)
Returns a given map as a Message object.
|
void |
check()
Checks that this object is ready for use with the SAMP toolkit.
|
java.lang.String |
getMType()
Returns this message's MType.
|
java.lang.Object |
getParam(java.lang.String name)
Returns the value of a single entry in this message's
samp.params map. |
java.util.Map |
getParams()
Returns this message's params map.
|
java.lang.Object |
getRequiredParam(java.lang.String name)
Returns the value of a single entry in this message's
samp.params map, throwing an exception
if it is not present. |
void |
setParams(java.util.Map params)
Sets this message's params map.
|
checkHasKeys, entrySet, getList, getMap, getString, getUrl, put
clear, clone, containsKey, containsValue, equals, get, hashCode, isEmpty, keySet, putAll, remove, size, toString, values
public static final java.lang.String MTYPE_KEY
public static final java.lang.String PARAMS_KEY
private static final java.lang.String[] KNOWN_KEYS
public Message()
public Message(java.util.Map map)
map
- map containing initial data for this objectpublic Message(java.lang.String mtype, java.util.Map params)
mtype
- value for MTYPE_KEY
keyparams
- value for PARAMS_KEY
keypublic Message(java.lang.String mtype)
mtype
- value for MTYPE_KEY
keypublic java.lang.String getMType()
MTYPE_KEY
public void setParams(java.util.Map params)
params
- value for PARAMS_KEY
public java.util.Map getParams()
PARAMS_KEY
public Message addParam(java.lang.String name, java.lang.Object value)
samp.params
map.name
- param namevalue
- param valuepublic java.lang.Object getParam(java.lang.String name)
samp.params
map. Null is returned if the parameter
does not appear.name
- param namepublic java.lang.Object getRequiredParam(java.lang.String name)
samp.params
map, throwing an exception
if it is not present.name
- param nameDataException
- if no parameter name
is presentpublic void check()
SampMap
SampUtils.checkMap(java.util.Map)
(ensuring that all keys
are Strings, and all values Strings, Lists or Maps), subclass-specific
invariants may be checked. In the case that there's something wrong,
an informative DataException
will be thrown.public static Message asMessage(java.util.Map map)
map
- map