Skip to content

Commit f115971

Browse files
author
WSSIA
committed
Fixed Checkstyle errors.
1 parent e1836fe commit f115971

5 files changed

Lines changed: 130 additions & 75 deletions

File tree

‎event-asynchronous/src/main/java/com/iluwatar/event/asynchronous/App.java‎

Lines changed: 42 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,11 @@ public class App {
5050

5151
boolean interactiveMode = false;
5252

53+
/**
54+
* Program entry point.
55+
*
56+
* @param args command line args
57+
*/
5358
public static void main(String[] args) {
5459
App app = new App();
5560

@@ -71,6 +76,7 @@ public void setUp() {
7176
try {
7277
prop.load(inputStream);
7378
} catch (IOException e) {
79+
System.out.println(propFileName + " was not found. Defaulting to non-interactive mode.");
7480
}
7581
String property = prop.getProperty("INTERACTIVE_MODE");
7682
if (property.equalsIgnoreCase("YES")) {
@@ -79,6 +85,9 @@ public void setUp() {
7985
}
8086
}
8187

88+
/**
89+
* Run program in either interactive mode or not.
90+
*/
8291
public void run() {
8392
if (interactiveMode) {
8493
runInteractiveMode();
@@ -87,36 +96,42 @@ public void run() {
8796
}
8897
}
8998

99+
/**
100+
* Run program in non-interactive mode.
101+
*/
90102
public void quickRun() {
91103
EventManager eventManager = new EventManager();
92104

93105
try {
94106
// Create an Asynchronous event.
95-
int aEventID = eventManager.createAsyncEvent(60);
96-
System.out.println("Event [" + aEventID + "] has been created.");
97-
eventManager.startEvent(aEventID);
98-
System.out.println("Event [" + aEventID + "] has been started.");
107+
int aEventId = eventManager.createAsyncEvent(60);
108+
System.out.println("Event [" + aEventId + "] has been created.");
109+
eventManager.startEvent(aEventId);
110+
System.out.println("Event [" + aEventId + "] has been started.");
99111

100112
// Create a Synchronous event.
101-
int sEventID = eventManager.createSyncEvent(60);
102-
System.out.println("Event [" + sEventID + "] has been created.");
103-
eventManager.startEvent(sEventID);
104-
System.out.println("Event [" + sEventID + "] has been started.");
113+
int sEventId = eventManager.createSyncEvent(60);
114+
System.out.println("Event [" + sEventId + "] has been created.");
115+
eventManager.startEvent(sEventId);
116+
System.out.println("Event [" + sEventId + "] has been started.");
105117

106-
eventManager.getStatus(aEventID);
107-
eventManager.getStatus(sEventID);
118+
eventManager.getStatus(aEventId);
119+
eventManager.getStatus(sEventId);
108120

109-
eventManager.stopEvent(aEventID);
110-
System.out.println("Event [" + aEventID + "] has been stopped.");
111-
eventManager.stopEvent(sEventID);
112-
System.out.println("Event [" + sEventID + "] has been stopped.");
121+
eventManager.stopEvent(aEventId);
122+
System.out.println("Event [" + aEventId + "] has been stopped.");
123+
eventManager.stopEvent(sEventId);
124+
System.out.println("Event [" + sEventId + "] has been stopped.");
113125

114126
} catch (MaxNumOfEventsAllowedException | LongRunningEventException | EventDoesNotExistException
115127
| InvalidOperationException e) {
116128
System.out.println(e.getMessage());
117129
}
118130
}
119131

132+
/**
133+
* Run program in interactive mode.
134+
*/
120135
public void runInteractiveMode() {
121136
EventManager eventManager = new EventManager();
122137

@@ -137,19 +152,19 @@ public void runInteractiveMode() {
137152
int eventTime = s.nextInt();
138153
if (eventType.equalsIgnoreCase("A")) {
139154
try {
140-
int eventID = eventManager.createAsyncEvent(eventTime);
141-
System.out.println("Event [" + eventID + "] has been created.");
142-
eventManager.startEvent(eventID);
143-
System.out.println("Event [" + eventID + "] has been started.");
155+
int eventId = eventManager.createAsyncEvent(eventTime);
156+
System.out.println("Event [" + eventId + "] has been created.");
157+
eventManager.startEvent(eventId);
158+
System.out.println("Event [" + eventId + "] has been started.");
144159
} catch (MaxNumOfEventsAllowedException | LongRunningEventException | EventDoesNotExistException e) {
145160
System.out.println(e.getMessage());
146161
}
147162
} else if (eventType.equalsIgnoreCase("S")) {
148163
try {
149-
int eventID = eventManager.createSyncEvent(eventTime);
150-
System.out.println("Event [" + eventID + "] has been created.");
151-
eventManager.startEvent(eventID);
152-
System.out.println("Event [" + eventID + "] has been started.");
164+
int eventId = eventManager.createSyncEvent(eventTime);
165+
System.out.println("Event [" + eventId + "] has been created.");
166+
eventManager.startEvent(eventId);
167+
System.out.println("Event [" + eventId + "] has been started.");
153168
} catch (MaxNumOfEventsAllowedException | InvalidOperationException | LongRunningEventException
154169
| EventDoesNotExistException e) {
155170
System.out.println(e.getMessage());
@@ -159,18 +174,18 @@ public void runInteractiveMode() {
159174
}
160175
} else if (option == 2) {
161176
System.out.print("Event ID: ");
162-
int eventID = s.nextInt();
177+
int eventId = s.nextInt();
163178
try {
164-
eventManager.stopEvent(eventID);
165-
System.out.println("Event [" + eventID + "] has been stopped.");
179+
eventManager.stopEvent(eventId);
180+
System.out.println("Event [" + eventId + "] has been stopped.");
166181
} catch (EventDoesNotExistException e) {
167182
System.out.println(e.getMessage());
168183
}
169184
} else if (option == 3) {
170185
System.out.print("Event ID: ");
171-
int eventID = s.nextInt();
186+
int eventId = s.nextInt();
172187
try {
173-
eventManager.getStatus(eventID);
188+
eventManager.getStatus(eventId);
174189
} catch (EventDoesNotExistException e) {
175190
System.out.println(e.getMessage());
176191
}

‎event-asynchronous/src/main/java/com/iluwatar/event/asynchronous/Event.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@
2323
*/
2424
public class Event implements IEvent, Runnable {
2525

26-
private int eventID;
26+
private int eventId;
2727
private int eventTime;
2828
private Thread thread;
2929
private long counter = 0;
3030
private boolean isComplete = false;
3131
private ThreadCompleteListener eventListener;
3232

33-
public Event(int eventID, int eventTime) {
34-
this.eventID = eventID;
33+
public Event(int eventId, int eventTime) {
34+
this.eventId = eventId;
3535
this.eventTime = eventTime;
3636
}
3737

@@ -49,9 +49,9 @@ public void stop() {
4949
@Override
5050
public void status() {
5151
if (!isComplete) {
52-
System.out.println("[" + eventID + "] I am at not done. [" + counter + "%]");
52+
System.out.println("[" + eventId + "] I am at not done. [" + counter + "%]");
5353
} else {
54-
System.out.println("[" + eventID + "] I am done.");
54+
System.out.println("[" + eventId + "] I am done.");
5555
}
5656
}
5757

@@ -81,7 +81,7 @@ public final void removeListener(final ThreadCompleteListener listener) {
8181

8282
private final void notifyListener() {
8383
if (eventListener != null) {
84-
eventListener.notifyOfThreadComplete(eventID);
84+
eventListener.notifyOfThreadComplete(eventId);
8585
}
8686
}
8787

‎event-asynchronous/src/main/java/com/iluwatar/event/asynchronous/EventManager.java‎

Lines changed: 71 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -32,34 +32,53 @@
3232
*/
3333
public class EventManager implements ThreadCompleteListener {
3434

35-
private int minID = 1;
36-
private int maxID = Integer.MAX_VALUE - 1; // Be cautious of overflows.
35+
private int minId = 1;
36+
private int maxId = Integer.MAX_VALUE - 1; // Be cautious of overflows.
3737
private int maxRunningEvents = 1000; // no particular reason. Just don't wanna have too many running events. :)
3838
private int maxEventTime = 1800; // in seconds / 30 minutes.
3939
private int currentlyRunningSyncEvent = -1;
4040
private Random rand;
4141
private Map<Integer, Event> eventPool;
4242

43+
/**
44+
* EventManager constructor.
45+
*
46+
*/
4347
public EventManager() {
4448
rand = new Random(1);
4549
eventPool = new ConcurrentHashMap<Integer, Event>(maxRunningEvents);
4650

4751
}
4852

49-
// Create a Synchronous event.
53+
/**
54+
* Create a Synchronous event.
55+
*
56+
* @param eventTime Time an event should run for.
57+
* @return eventId
58+
* @throws MaxNumOfEventsAllowedException When too many events are running at a time.
59+
* @throws InvalidOperationException No new synchronous events can be created when one is already running.
60+
* @throws LongRunningEventException Long running events are not allowed in the app.
61+
*/
5062
public int createSyncEvent(int eventTime)
5163
throws MaxNumOfEventsAllowedException, InvalidOperationException, LongRunningEventException {
52-
int eventID = createEvent(eventTime);
64+
int eventId = createEvent(eventTime);
5365
if (currentlyRunningSyncEvent != -1) {
5466
throw new InvalidOperationException(
5567
"Event [" + currentlyRunningSyncEvent + "] is still running. Please wait until it finishes and try again.");
5668
}
57-
currentlyRunningSyncEvent = eventID;
69+
currentlyRunningSyncEvent = eventId;
5870

59-
return eventID;
71+
return eventId;
6072
}
6173

62-
// Create an Asynchronous event.
74+
/**
75+
* Create an Asynchronous event.
76+
*
77+
* @param eventTime Time an event should run for.
78+
* @return eventId
79+
* @throws MaxNumOfEventsAllowedException When too many events are running at a time.
80+
* @throws LongRunningEventException Long running events are not allowed in the app.
81+
*/
6382
public int createAsyncEvent(int eventTime) throws MaxNumOfEventsAllowedException, LongRunningEventException {
6483
return createEvent(eventTime);
6584
}
@@ -74,44 +93,65 @@ private int createEvent(int eventTime) throws MaxNumOfEventsAllowedException, Lo
7493
"Maximum event time allowed is " + maxEventTime + " seconds. Please try again.");
7594
}
7695

77-
int newEventID = generateID();
96+
int newEventId = generateId();
7897

79-
Event newEvent = new Event(newEventID, eventTime);
98+
Event newEvent = new Event(newEventId, eventTime);
8099
newEvent.addListener(this);
81-
eventPool.put(newEventID, newEvent);
100+
eventPool.put(newEventId, newEvent);
82101

83-
return newEventID;
102+
return newEventId;
84103
}
85104

86-
public void startEvent(int eventID) throws EventDoesNotExistException {
87-
if (!eventPool.containsKey(eventID)) {
88-
throw new EventDoesNotExistException(eventID + " does not exist.");
105+
/**
106+
* Starts event.
107+
*
108+
* @param eventId The event that needs to be started.
109+
* @throws EventDoesNotExistException If event does not exist in our eventPool.
110+
*/
111+
public void startEvent(int eventId) throws EventDoesNotExistException {
112+
if (!eventPool.containsKey(eventId)) {
113+
throw new EventDoesNotExistException(eventId + " does not exist.");
89114
}
90115

91-
eventPool.get(eventID).start();
116+
eventPool.get(eventId).start();
92117
}
93118

94-
public void stopEvent(int eventID) throws EventDoesNotExistException {
95-
if (!eventPool.containsKey(eventID)) {
96-
throw new EventDoesNotExistException(eventID + " does not exist.");
119+
/**
120+
* Stops event.
121+
*
122+
* @param eventId The event that needs to be stopped.
123+
* @throws EventDoesNotExistException If event does not exist in our eventPool.
124+
*/
125+
public void stopEvent(int eventId) throws EventDoesNotExistException {
126+
if (!eventPool.containsKey(eventId)) {
127+
throw new EventDoesNotExistException(eventId + " does not exist.");
97128
}
98129

99-
if (eventID == currentlyRunningSyncEvent) {
130+
if (eventId == currentlyRunningSyncEvent) {
100131
currentlyRunningSyncEvent = -1;
101132
}
102133

103-
eventPool.get(eventID).stop();
104-
eventPool.remove(eventID);
134+
eventPool.get(eventId).stop();
135+
eventPool.remove(eventId);
105136
}
106137

107-
public void getStatus(int eventID) throws EventDoesNotExistException {
108-
if (!eventPool.containsKey(eventID)) {
109-
throw new EventDoesNotExistException(eventID + " does not exist.");
138+
/**
139+
* Get status of a running event.
140+
*
141+
* @param eventId The event to inquire status of.
142+
* @throws EventDoesNotExistException If event does not exist in our eventPool.
143+
*/
144+
public void getStatus(int eventId) throws EventDoesNotExistException {
145+
if (!eventPool.containsKey(eventId)) {
146+
throw new EventDoesNotExistException(eventId + " does not exist.");
110147
}
111148

112-
eventPool.get(eventID).status();
149+
eventPool.get(eventId).status();
113150
}
114151

152+
/**
153+
* Gets status of all running events.
154+
*/
115155
@SuppressWarnings("rawtypes")
116156
public void getStatusOfAllEvents() {
117157
Iterator it = eventPool.entrySet().iterator();
@@ -125,12 +165,12 @@ public void getStatusOfAllEvents() {
125165
* Returns a pseudo-random number between min and max, inclusive. The difference between min and max can be at most
126166
* <code>Integer.MAX_VALUE - 1</code>.
127167
*/
128-
private int generateID() {
168+
private int generateId() {
129169
// nextInt is normally exclusive of the top value,
130170
// so add 1 to make it inclusive
131-
int randomNum = rand.nextInt((maxID - minID) + 1) + minID;
171+
int randomNum = rand.nextInt((maxId - minId) + 1) + minId;
132172
while (eventPool.containsKey(randomNum)) {
133-
randomNum = rand.nextInt((maxID - minID) + 1) + minID;
173+
randomNum = rand.nextInt((maxId - minId) + 1) + minId;
134174
}
135175

136176
return randomNum;
@@ -140,9 +180,9 @@ private int generateID() {
140180
* Callback from an {@link Event} (once it is complete). The Event is then removed from the pool.
141181
*/
142182
@Override
143-
public void notifyOfThreadComplete(int eventID) {
144-
eventPool.get(eventID).status();
145-
eventPool.remove(eventID);
183+
public void notifyOfThreadComplete(int eventId) {
184+
eventPool.get(eventId).status();
185+
eventPool.remove(eventId);
146186
}
147187

148188
}

‎event-asynchronous/src/main/java/com/iluwatar/event/asynchronous/ThreadCompleteListener.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@
1717
package com.iluwatar.event.asynchronous;
1818

1919
public interface ThreadCompleteListener {
20-
void notifyOfThreadComplete(final int eventID);
20+
void notifyOfThreadComplete(final int eventId);
2121
}

0 commit comments

Comments
 (0)