Message.java
4.64 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
/*
* This file is part of LiteLoader.
* Copyright (C) 2012-16 Adam Mummery-Smith
* All Rights Reserved.
*/
package com.mumfrey.liteloader.messaging;
import java.util.HashMap;
import java.util.Map;
import java.util.regex.Pattern;
import com.google.common.collect.ImmutableMap;
/**
* Class used to encapsulate a MessageBus message
*
* @author Adam Mummery-Smith
*/
public final class Message
{
/**
* Regex for matching valid channels
*/
private static final Pattern channelPattern = Pattern.compile("^[a-z0-9]([a-z0-9_\\-]*[a-z0-9])?:[a-z0-9]([a-z0-9_\\-]*[a-z0-9])?$",
Pattern.CASE_INSENSITIVE);
private final String channel, replyChannel;
private final Messenger sender;
private final Map<String, ?> payload;
Message(String channel, Object value, Messenger sender)
{
this(channel, value, sender, null);
}
Message(String channel, Object value, Messenger sender, String replyChannel)
{
Message.validateChannel(channel);
this.channel = channel;
this.payload = ImmutableMap.<String, Object>of("value", value);
this.sender = sender;
this.replyChannel = replyChannel;
}
Message(String channel, Map<String, ?> payload, Messenger sender)
{
this(channel, payload, sender, null);
}
Message(String channel, Map<String, ?> payload, Messenger sender, String replyChannel)
{
Message.validateChannel(channel);
this.channel = channel;
this.payload = payload != null ? ImmutableMap.copyOf(payload) : ImmutableMap.<String, String>of();
this.sender = sender;
this.replyChannel = replyChannel;
}
/**
* Get the channel (fully qualified) that this message was sent on
*/
public String getChannel()
{
return this.channel;
}
/**
* Get the channel category for this message
*/
public String getCategory()
{
return this.channel.substring(0, this.channel.indexOf(':'));
}
/**
* Get the specified reply channel (if any) for this message - may return
* null
*/
public String getReplyChannel()
{
return this.replyChannel;
}
/**
* Get the message sender (if any) for this message - may return null
*/
public Messenger getSender()
{
return this.sender;
}
/**
* Get the message payload
*/
public Map<String, ?> getPayload()
{
return this.payload;
}
/**
* Check if this message is on the specified channel
*
* @param channel Full name of the channel to check against (case sensitive)
*/
public boolean isChannel(String channel)
{
return this.channel.equals(channel);
}
/**
* Check if this message has the specified category
*
* @param category
*/
public boolean isCategory(String category)
{
return this.getCategory().equals(category);
}
/**
* Get (and implicit cast) a value from this message's payload
*
* @param key
*/
@SuppressWarnings("unchecked")
public <T> T get(String key)
{
return (T)this.payload.get(key);
}
@SuppressWarnings("unchecked")
public <T> T get(String key, T defaultValue)
{
Object value = this.payload.get(key);
if (value != null)
{
return (T)value;
}
return defaultValue;
}
/**
* Gets the payload with the key "value", which is used with messages
* constructed using a object-only payload.
*/
public <T> T getValue()
{
return this.get("value");
}
public static void validateChannel(String channel) throws IllegalArgumentException
{
if (channel == null)
{
throw new IllegalArgumentException("Channel name cannot be null");
}
if (!Message.isValidChannel(channel))
{
throw new IllegalArgumentException("'" + channel + "' is not a valid channel name");
}
}
public static boolean isValidChannel(String channel)
{
return Message.channelPattern.matcher(channel).matches();
}
/**
* Build a KV map from interleaved keys and values, convenience function
*
* @param args
*/
public static Map<String, ?> buildMap(Object... args)
{
Map<String, Object> payload = new HashMap<String, Object>();
for (int i = 0; i < args.length - 1; i += 2)
{
if (args[i] instanceof String)
{
payload.put((String)args[i], args[i + 1]);
}
}
return payload;
}
}