KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > event > EventSubject


1 /* ====================================================================
2  *
3  * The ObjectStyle Group Software License, version 1.1
4  * ObjectStyle Group - http://objectstyle.org/
5  *
6  * Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
7  * of the software. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution, if any,
22  * must include the following acknowlegement:
23  * "This product includes software developed by independent contributors
24  * and hosted on ObjectStyle Group web site (http://objectstyle.org/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The names "ObjectStyle Group" and "Cayenne" must not be used to endorse
29  * or promote products derived from this software without prior written
30  * permission. For written permission, email
31  * "andrus at objectstyle dot org".
32  *
33  * 5. Products derived from this software may not be called "ObjectStyle"
34  * or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
35  * names without prior written permission.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals and hosted on ObjectStyle Group web site. For more
53  * information on the ObjectStyle Group, please see
54  * <http://objectstyle.org/>.
55  */

56
57 package org.objectstyle.cayenne.event;
58
59 import java.util.Map JavaDoc;
60
61 import org.apache.commons.collections.map.ReferenceMap;
62
63 /**
64  * This class encapsulates the String that is used to identify the <em>subject</em>
65  * that a listener is interested in. Using plain Strings causes several severe
66  * problems:
67  * <ul>
68  * <li>it's easy to misspell a subject, leading to undesired behaviour at
69  * runtime that is hard to debug.</li>
70  * <li>in systems with many different subjects there is no safeguard for
71  * defining the same subject twice for different purposes. This is especially
72  * true in a distributed setting.
73  * </ul>
74  *
75  * @author Dirk Olmes
76  * @author Holger Hoffstaette
77  */

78
79 public class EventSubject extends Object JavaDoc {
80
81     // a Map that will allow the values to be GC'ed
82
private static Map JavaDoc _registeredSubjects =
83         new ReferenceMap(ReferenceMap.HARD, ReferenceMap.WEAK);
84
85     // Subject identifier in the form "com.foo.bar/SubjectName"
86
private String JavaDoc _fullyQualifiedSubjectName;
87
88     /**
89      * Returns an event subject identified by the given owner and subject name.
90      *
91      * @param subjectOwner the Class used for uniquely identifying this subject
92      * @param subjectName a String used as name, e.g. "MyEventTopic"
93      * @throws IllegalArgumentException if subjectOwner/subjectName are
94      * <code>null</code> or subjectName is empty.
95      */

96     public static EventSubject getSubject(Class JavaDoc subjectOwner, String JavaDoc subjectName) {
97         if (subjectOwner == null) {
98             throw new IllegalArgumentException JavaDoc("Owner class must not be null.");
99         }
100
101         if ((subjectName == null) || (subjectName.length() == 0)) {
102             throw new IllegalArgumentException JavaDoc("Subject name must not be null or empty.");
103         }
104
105         String JavaDoc fullSubjectName = subjectOwner.getName() + "/" + subjectName;
106         EventSubject newSubject = (EventSubject) _registeredSubjects.get(fullSubjectName);
107         if (newSubject == null) {
108             newSubject = new EventSubject(fullSubjectName);
109             _registeredSubjects.put(newSubject.getSubjectName(), newSubject);
110         }
111
112         return newSubject;
113     }
114
115     /**
116      * Private constructor to force use of #getSubject(Class, String)
117      */

118     private EventSubject() {
119     }
120
121     /**
122      * Protected constructor for new subjects.
123      *
124      * @param fullSubjectName the name of the new subject to be created
125      */

126     protected EventSubject(String JavaDoc fullSubjectName) {
127         super();
128         _fullyQualifiedSubjectName = fullSubjectName;
129     }
130
131     public boolean equals(Object JavaDoc obj) {
132         if (obj instanceof EventSubject) {
133             return _fullyQualifiedSubjectName.equals(
134                 ((EventSubject) obj).getSubjectName());
135         }
136
137         return false;
138     }
139
140     public int hashCode() {
141         return (super.hashCode() ^ _fullyQualifiedSubjectName.hashCode());
142     }
143
144     public String JavaDoc getSubjectName() {
145         return _fullyQualifiedSubjectName;
146     }
147
148     /**
149      * @return a String in the form
150      * <code>&lt;ClassName 0x123456&gt; SomeName</code>
151      *
152      * @see Object#toString()
153      */

154     public String JavaDoc toString() {
155         StringBuffer JavaDoc buf = new StringBuffer JavaDoc(64);
156
157         buf.append("<");
158         buf.append(this.getClass().getName());
159         buf.append(" 0x");
160         buf.append(Integer.toHexString(System.identityHashCode(this)));
161         buf.append("> ");
162         buf.append(_fullyQualifiedSubjectName);
163
164         return buf.toString();
165     }
166
167 }
168
Popular Tags