2 * Copyright 2005-2010 the original author or authors.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
16 package org.wamblee.test;
18 import org.apache.commons.logging.Log;
19 import org.apache.commons.logging.LogFactory;
21 import java.util.ArrayList;
22 import java.util.Collections;
23 import java.util.HashMap;
24 import java.util.List;
28 * Tracks the occurence of certain events in a test environment. Threads in a
29 * test environment tell the event tracker of the occurrence of certain events
30 * using {@link #eventOccurred(Event)}. Test code inspects the events sent by a
31 * thread using {@link #isEventSent(Thread, Event)}.
33 * A record is kept of every event which is sent. Therefore, the occurrence of a
34 * new event does not erase a previously sent event.
37 * Type of event sent from test code. Usually String will be
38 * sufficient. The event type must provide a sensible implementation
39 * of {@link java.lang.Object#equals(java.lang.Object)}.
41 * @author Erik Brakkee
43 public class EventTracker<Event> {
44 private static final Log LOG = LogFactory.getLog(EventTracker.class);
47 * Map of Thread object to a list of events.
49 private Map<Thread, List<Event>> events;
52 * Constructs the event tracker.
55 public EventTracker() {
59 public synchronized void clear() {
60 events = new HashMap<Thread, List<Event>>();
64 * Called by a thread to inform that an event has occurred.
67 * Event that was sent.
69 public synchronized void eventOccurred(Event aEvent) {
70 LOG.info("Event '" + aEvent + "' sent.");
72 Thread current = Thread.currentThread();
73 List<Event> eventList = events.get(current);
75 if (eventList == null) {
76 eventList = new ArrayList<Event>();
77 events.put(current, eventList);
80 eventList.add(aEvent);
84 * Checks if a specific event has happened in a specific thread.
90 * @return Whether or not the event was sent.
92 public synchronized boolean isEventSent(Thread aThread, Event aEvent) {
93 List<Event> eventList = events.get(aThread);
95 if (eventList == null) {
99 return eventList.contains(aEvent);
103 * Gets the events for a thread in the order they were sent
106 * Thread to get events for.
107 * @return Events that were sent. A zero-sized array is returned if no
110 public synchronized List<Event> getEvents(Thread aThread) {
111 List<Event> eventList = events.get(aThread);
113 if (eventList == null) {
114 eventList = Collections.emptyList();
117 return Collections.unmodifiableList(eventList);
121 * Gets the number of times an event was sent summed up over all threads.
125 * @return Number of times it was reached.
127 public synchronized int getEventCount(Event aEvent) {
130 for (Thread thread : events.keySet()) {
131 List<Event> eventList = events.get(thread);
133 for (Event event : eventList) {
134 if (event.equals(aEvent)) {
144 * Gets the total event count over all threads.
148 public synchronized int getEventCount() {
151 for (Thread thread : events.keySet()) {
152 count += events.get(thread).size();