1 /*
2 * Copyright (c) 1998, 2005 Gargoyle Software Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * 1. Redistributions of source code must retain the above copyright notice,
8 * this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright notice,
10 * this list of conditions and the following disclaimer in the documentation
11 * and/or other materials provided with the distribution.
12 * 3. The end-user documentation included with the redistribution, if any, must
13 * include the following acknowledgment:
14 *
15 * "This product includes software developed by Gargoyle Software Inc.
16 * (http://www.GargoyleSoftware.com/)."
17 *
18 * Alternately, this acknowledgment may appear in the software itself, if
19 * and wherever such third-party acknowledgments normally appear.
20 * 4. The name "Gargoyle Software" must not be used to endorse or promote
21 * products derived from this software without prior written permission.
22 * For written permission, please contact info@GargoyleSoftware.com.
23 * 5. Products derived from this software may not be called "GSBase", nor may
24 * "GSBase" appear in their name, without prior written permission of
25 * Gargoyle Software Inc.
26 *
27 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
28 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
29 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE
30 * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
31 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
33 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
36 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 */
38 package com.gargoylesoftware.base.testing;
39
40 import java.lang.reflect.Method;
41 import java.util.EventObject;
42
43 /***
44 * Information about a single event that was caught by an
45 * {@link com.gargoylesoftware.base.testing.EventCatcher}
46 *
47 * @version $Revision: 1.4 $
48 * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
49 */
50 public class EventCatcherRecord {
51 private final Method method_;
52 private final EventObject event_;
53 private final String callingThread_;
54
55 /***
56 * Create a new Record
57 * @param method The method that caught the event.
58 * @param event The event that was caught.
59 */
60 public EventCatcherRecord( final Method method, final EventObject event ) {
61 method_ = method;
62 event_ = event;
63 callingThread_ = Thread.currentThread().getName();
64 }
65
66 /***
67 * Return the method that had been invoked with the specified event. For example,
68 * if we had caught a WindowEvent then the method might be windowClosing()
69 *
70 * @return The method
71 */
72 public Method getMethod() {
73 return method_;
74 }
75
76 /***
77 * Return the event that had been caught. For example, a WindowEvent
78 * @return The event.
79 */
80 public EventObject getEvent() {
81 return event_;
82 }
83
84 /***
85 * Return the name of the thread that the event was called on. For AWT events,
86 * this will typically be the event dispatch (UI) thread.
87 *
88 * @return The thread name.
89 */
90 public String getThreadName() {
91 return callingThread_;
92 }
93 }
94