File Source: CoreActionType.java
1 /*
2 * Copyright (c) 2006-2009 Chris Smith, Shane Mc Cormack, Gregory Holmes
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 * SOFTWARE.
21 */
22
23 package com.dmdirc.actions;
24
25 import com.dmdirc.actions.interfaces.ActionType;
26 import com.dmdirc.actions.interfaces.ActionMetaType;
27 import com.dmdirc.actions.metatypes.ActionEvents;
28 import com.dmdirc.actions.metatypes.ChannelEvents;
29 import com.dmdirc.actions.metatypes.ClientEvents;
30 import com.dmdirc.actions.metatypes.PluginEvents;
31 import com.dmdirc.actions.metatypes.QueryEvents;
32 import com.dmdirc.actions.metatypes.ServerEvents;
33
34 /**
35 * An enumeration of actions that are raised by the core.
36 * @author chris
37 */
/*
P/P * Method: CoreActionType valueOf(String)
*
* Postconditions:
* init'ed(return_value)
*/
38 public enum CoreActionType implements ActionType {
39
40 /** Client opened. */
/*
P/P * Method: com.dmdirc.actions.CoreActionType__static_init
*
* Postconditions:
* $VALUES == &new CoreActionType[](CoreActionType__static_init#74)
* ACTION_CREATED == &new CoreActionType(CoreActionType__static_init#71)
* ACTION_DELETED == &new CoreActionType(CoreActionType__static_init#73)
* ACTION_UPDATED == &new CoreActionType(CoreActionType__static_init#72)
* CHANNEL_ACTION == &new CoreActionType(CoreActionType__static_init#47)
* CHANNEL_CLOSED == &new CoreActionType(CoreActionType__static_init#41)
* CHANNEL_CTCP == &new CoreActionType(CoreActionType__static_init#49)
* CHANNEL_GOTNAMES == &new CoreActionType(CoreActionType__static_init#42)
* CHANNEL_GOTTOPIC == &new CoreActionType(CoreActionType__static_init#43)
* CHANNEL_JOIN == &new CoreActionType(CoreActionType__static_init#50)
* ...
*/
41 CLIENT_OPENED(ClientEvents.CLIENT_EVENT, "Client opened"),
42 /** Client closed. */
43 CLIENT_CLOSED(ClientEvents.CLIENT_EVENT, "Client closed"),
44 /** Client closing. */
45 CLIENT_CLOSING(ClientEvents.CLIENT_EVENT, "Client closing"),
46 /** Client minimised. */
47 CLIENT_MINIMISED(ClientEvents.CLIENT_EVENT, "Client minimised"),
48 /** Client unminimised. */
49 CLIENT_UNMINIMISED(ClientEvents.CLIENT_EVENT, "Client unminimised"),
50
51 /** Function key pressed. */
52 CLIENT_KEY_PRESSED(ClientEvents.CLIENT_EVENT_WITH_KEY, "Function key pressed"),
53
54 /** Frame changed. */
55 CLIENT_FRAME_CHANGED(ClientEvents.WINDOW_EVENT, "Frame changed"),
56 /** User input. */
57 CLIENT_USER_INPUT(ClientEvents.CLIENT_EVENT_WITH_BUFFER, "User input"),
58 /** Line added. */
59 CLIENT_LINE_ADDED(ClientEvents.WINDOW_EVENT_WITH_MESSAGE, "Line added to a window"),
60 /** Popup generated. */
61 CLIENT_POPUP_GENERATED(ClientEvents.POPUP_EVENT, "Popup menu generated"),
62 /** String styled. */
63 CLIENT_STRING_STYLED(ClientEvents.CLIENT_EVENT_WITH_STYLE, "String styled"),
64
65 /** Prefs dialog opened. */
66 CLIENT_PREFS_OPENED(ClientEvents.CLIENT_EVENT_WITH_PREFS, "Preferences dialog opened"),
67 /** Prefs dialog closed. */
68 CLIENT_PREFS_CLOSED(ClientEvents.CLIENT_EVENT, "Preferences dialog opened"),
69
70 /** Unknown command. */
71 UNKNOWN_COMMAND(ClientEvents.UNKNOWN_COMMAND, "Unknown command entered"),
72
73 /** Server numeric received. */
74 SERVER_NUMERIC(ServerEvents.SERVER_NUMERIC, "Numeric event received"),
75 /** Server connected. */
76 SERVER_CONNECTED(ServerEvents.SERVER_EVENT, "Server connected"),
77 /** Server connecting. */
78 SERVER_CONNECTING(ServerEvents.SERVER_EVENT, "Server connecting"),
79 /** Server connection error. */
80 SERVER_CONNECTERROR(ServerEvents.SERVER_EVENT_WITH_ARG, "Server connection error"),
81 /** Server disconnected. */
82 SERVER_DISCONNECTED(ServerEvents.SERVER_EVENT, "Server disconnected"),
83 /** Marked as away. */
84 SERVER_BACK(ServerEvents.SERVER_EVENT, "Marked as 'back'"),
85 /** Marked as back. */
86 SERVER_AWAY(ServerEvents.SERVER_EVENT_WITH_ARG, "Marked as 'away'"),
87 /** Error. */
88 SERVER_ERROR(ServerEvents.SERVER_EVENT_WITH_ARG, "Server error"),
89
90 /** Auth notice received. */
91 SERVER_AUTHNOTICE(ServerEvents.SERVER_EVENT_WITH_ARG, "Received auth notice"),
92 /** Unknown notice received. */
93 SERVER_UNKNOWNNOTICE(ServerEvents.SERVER_UNKNOWN_EVENT, "Received unknown notice"),
94
95 /** User modes changed. */
96 SERVER_USERMODES(ServerEvents.SERVER_SOURCED_EVENT_WITH_ARG, "User modes changed"),
97
98 /** Private CTCP received. */
99 SERVER_CTCP(ServerEvents.SERVER_CTCP_EVENT, "CTCP received"),
100 /** Private CTCPR received. */
101 SERVER_CTCPR(ServerEvents.SERVER_CTCP_EVENT, "CTCP reply received"),
102
103 /** Private notice received. */
104 SERVER_NOTICE(ServerEvents.SERVER_SOURCED_EVENT_WITH_ARG, "Notice received"),
105
106 /** MOTD starting. */
107 SERVER_MOTDSTART(ServerEvents.SERVER_EVENT_WITH_ARG, "Start of MOTD received"),
108 /** MOTD ended. */
109 SERVER_MOTDEND(ServerEvents.SERVER_EVENT_WITH_ARG, "End of MOTD received"),
110 /** MOTD line. */
111 SERVER_MOTDLINE(ServerEvents.SERVER_EVENT_WITH_ARG, "MOTD line received"),
112
113 /** Ping reply received. */
114 SERVER_GOTPING(ServerEvents.SERVER_PING, "Received server ping reply"),
115 /** Missed server ping reply. */
116 SERVER_NOPING(ServerEvents.SERVER_PING, "Missed server ping reply"),
117 /** Ping sent. */
118 SERVER_PINGSENT(ServerEvents.SERVER_EVENT, "Ping request sent"),
119
120 /** Invite received. */
121 SERVER_INVITERECEIVED(ServerEvents.SERVER_INVITE, "Invite received"),
122
123 /** Wallops. */
124 SERVER_WALLOPS(ServerEvents.SERVER_SOURCED_EVENT_WITH_ARG, "Wallop received"),
125 /** Wallusers. */
126 SERVER_WALLUSERS(ServerEvents.SERVER_SOURCED_EVENT_WITH_ARG, "Walluser received"),
127 /** Walldesync. */
128 SERVER_WALLDESYNC(ServerEvents.SERVER_SOURCED_EVENT_WITH_ARG, "Walldesync received"),
129
130 /** Nick change. */
131 SERVER_NICKCHANGE(ServerEvents.SERVER_NICKCHANGE, "My nickname changed"),
132
133 /** Channel window opened. */
134 CHANNEL_OPENED(ChannelEvents.CHANNEL_EVENT, "Channel window opened"),
135 /** Channel window closed. */
136 CHANNEL_CLOSED(ChannelEvents.CHANNEL_EVENT, "Channel window closed"),
137 /** Names reply received. */
138 CHANNEL_GOTNAMES(ChannelEvents.CHANNEL_EVENT, "Channel names reply received"),
139 /** Channel topic received. */
140 CHANNEL_GOTTOPIC(ChannelEvents.CHANNEL_TOPICEVENT, "Channel topic received"),
141
142 /** Channel message sent. */
143 CHANNEL_SELF_MESSAGE(ChannelEvents.CHANNEL_SOURCED_EVENT_WITH_ARG, "Channel message sent"),
144 /** Channel action sent. */
145 CHANNEL_SELF_ACTION(ChannelEvents.CHANNEL_SOURCED_EVENT_WITH_ARG, "Channel action sent"),
146
147 /** Channel message received. */
148 CHANNEL_MESSAGE(ChannelEvents.CHANNEL_SOURCED_EVENT_WITH_ARG, "Channel message received"),
149 /** Channel actions received. */
150 CHANNEL_ACTION(ChannelEvents.CHANNEL_SOURCED_EVENT_WITH_ARG, "Channel action received"),
151 /** Channel notice received. */
152 CHANNEL_NOTICE(ChannelEvents.CHANNEL_SOURCED_EVENT_WITH_ARG, "Channel notice received"),
153
154 /** Channel CTCP received. */
155 CHANNEL_CTCP(ChannelEvents.CHANNEL_CTCP, "Channel CTCP received"),
156
157 /** Someone joined a channel. */
158 CHANNEL_JOIN(ChannelEvents.CHANNEL_SOURCED_EVENT, "Someone joined a channel"),
159 /** Someone left a channel. */
160 CHANNEL_PART(ChannelEvents.CHANNEL_SOURCED_EVENT_WITH_ARG, "Someone left a channel"),
161 /** Someone quit. */
162 CHANNEL_QUIT(ChannelEvents.CHANNEL_SOURCED_EVENT_WITH_ARG, "Someone quit IRC"),
163 /** Someone was kicked. */
164 CHANNEL_KICK(ChannelEvents.CHANNEL_SOURCED_EVENT_WITH_VICTIM, "Someone kicked someone"),
165
166 /** Someone marked as away. */
167 CHANNEL_USERAWAY(ChannelEvents.CHANNEL_SOURCED_EVENT, "Someone is marked as 'away'"),
168 /** Someone marked as back. */
169 CHANNEL_USERBACK(ChannelEvents.CHANNEL_SOURCED_EVENT, "Someone is marked as 'back'"),
170
171 /** Channel mode discovered. */
172 CHANNEL_MODESDISCOVERED(ChannelEvents.CHANNEL_MODEEVENT, "Channel modes discovered"),
173 /** Channel mode changes. */
174 CHANNEL_MODECHANGE(ChannelEvents.CHANNEL_SOURCED_EVENT_WITH_ARG, "Someone changed channel modes"),
175 /** Someone changed someone else's user modes. */
176 CHANNEL_USERMODECHANGE(ChannelEvents.CHANNEL_SOURCED_EVENT_WITH_VICTIM, "Someone changed someone else's modes"),
177
178 /** Someone changed nickname. */
179 CHANNEL_NICKCHANGE(ChannelEvents.CHANNEL_SOURCED_EVENT_WITH_ARG, "Someone changed nicknames"),
180
181 /** Someone changed a topic. */
182 CHANNEL_TOPICCHANGE(ChannelEvents.CHANNEL_SOURCED_EVENT_WITH_ARG, "Someone changed channel topic"),
183
184 /** Query opened. */
185 QUERY_OPENED(QueryEvents.QUERY_EVENT, "Query window opened"),
186 /** Query closed. */
187 QUERY_CLOSED(QueryEvents.QUERY_EVENT, "Query window closed"),
188 /** Query message received. */
189 QUERY_MESSAGE(QueryEvents.QUERY_EVENT_WITH_ARG, "Private message received"),
190 /** Query action received. */
191 QUERY_ACTION(QueryEvents.QUERY_EVENT_WITH_ARG, "Private action received"),
192 /** Query message sent. */
193 QUERY_SELF_MESSAGE(QueryEvents.QUERY_EVENT_WITH_ARG, "Private message sent"),
194 /** Query action sent. */
195 QUERY_SELF_ACTION(QueryEvents.QUERY_EVENT_WITH_ARG, "Private action sent"),
196 /** Query quit event. */
197 QUERY_QUIT(QueryEvents.QUERY_EVENT_WITH_ARG, "Query: user quit"),
198 /** Query nick change. */
199 QUERY_NICKCHANGE(QueryEvents.QUERY_EVENT_WITH_ARG, "Query: user changed nicks"),
200
201 /** Plugin loaded. */
202 PLUGIN_LOADED(PluginEvents.PLUGIN_EVENT, "Plugin loaded"),
203 /** Plugin unloaded. */
204 PLUGIN_UNLOADED(PluginEvents.PLUGIN_EVENT, "Plugin unloaded"),
205
206 /** Action created. */
207 ACTION_CREATED(ActionEvents.ACTION_EVENT, "Action created"),
208 /** Action updated. */
209 ACTION_UPDATED(ActionEvents.ACTION_EVENT, "Action updated"),
210 /** Action deleted. */
211 ACTION_DELETED(ActionEvents.ACTION_DELETED, "Action deleted");
212
213 /** The type of this action. */
214 private final ActionMetaType type;
215
216 /** The name of this action. */
217 private final String name;
218
219 /**
220 * Constructs a new core action.
221 * @param type The type of this action
222 * @param name The name of this action
223 */
/*
P/P * Method: void com.dmdirc.actions.CoreActionType(String, int, ActionMetaType, String)
*
* Postconditions:
* this.name == name
* init'ed(this.name)
* this.type == type
* init'ed(this.type)
*/
224 CoreActionType(final ActionMetaType type, final String name) {
225 this.type = type;
226 this.name = name;
227 }
228
229 /** {@inheritDoc} */
230 @Override
231 public ActionMetaType getType() {
/*
P/P * Method: ActionMetaType getType()
*
* Postconditions:
* return_value == this.type
* init'ed(return_value)
*/
232 return type;
233 }
234
235 /** {@inheritDoc} */
236 @Override
237 public String getName() {
/*
P/P * Method: String getName()
*
* Postconditions:
* return_value == this.name
* init'ed(return_value)
*/
238 return name;
239 }
240 }
SofCheck Inspector Build Version : 2.17854
| CoreActionType.java |
2009-Jun-25 01:54:24 |
| CoreActionType.class |
2009-Sep-02 17:04:13 |