001: /*
002: * ====================================================================
003: * JAFFA - Java Application Framework For All
004: *
005: * Copyright (C) 2002 JAFFA Development Group
006: *
007: * This library is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU Lesser General Public
009: * License as published by the Free Software Foundation; either
010: * version 2.1 of the License, or (at your option) any later version.
011: *
012: * This library is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this library; if not, write to the Free Software
019: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020: *
021: * Redistribution and use of this software and associated documentation ("Software"),
022: * with or without modification, are permitted provided that the following conditions are met:
023: * 1. Redistributions of source code must retain copyright statements and notices.
024: * Redistributions must also contain a copy of this document.
025: * 2. Redistributions in binary form must reproduce the above copyright notice,
026: * this list of conditions and the following disclaimer in the documentation
027: * and/or other materials provided with the distribution.
028: * 3. The name "JAFFA" must not be used to endorse or promote products derived from
029: * this Software without prior written permission. For written permission,
030: * please contact mail to: jaffagroup@yahoo.com.
031: * 4. Products derived from this Software may not be called "JAFFA" nor may "JAFFA"
032: * appear in their names without prior written permission.
033: * 5. Due credit should be given to the JAFFA Project (http://jaffa.sourceforge.net).
034: *
035: * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
036: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
037: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
038: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
039: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
040: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
041: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
042: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
043: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
044: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
045: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
046: * SUCH DAMAGE.
047: * ====================================================================
048: */
049:
050: package org.jaffa.components.maint;
051:
052: import org.jaffa.presentation.portlet.component.Component;
053: import java.util.Collection;
054: import java.util.HashSet;
055: import java.util.Iterator;
056: import java.util.EventObject;
057:
058: /** This is an abstract implementation of the IUpdateComponent interface.
059: * All the Update components should extend this component.
060: *
061: * @author GautamJ
062: */
063: public abstract class UpdateComponent extends Component implements
064: IUpdateComponent {
065:
066: private Collection m_updateListeners;
067:
068: /** Adds a listener.
069: * @param listener the listener.
070: */
071: public void addUpdateListener(IUpdateListener listener) {
072: if (m_updateListeners == null)
073: m_updateListeners = new HashSet();
074: m_updateListeners.add(listener);
075: }
076:
077: /** Removes a listener.
078: * @param listener the listener.
079: * @return true if the listener was removed.
080: */
081: public boolean removeUpdateListener(IUpdateListener listener) {
082: if (m_updateListeners != null)
083: return m_updateListeners.remove(listener);
084: else
085: return false;
086: }
087:
088: /** This clears the internal collection of listeners.
089: * It then invokes the quit() method of the base class.
090: */
091: public void quit() {
092: if (m_updateListeners != null) {
093: m_updateListeners.clear();
094: m_updateListeners = null;
095: }
096: super .quit();
097: }
098:
099: /** Returns a Collection of IUpdateListener objects.
100: * @return a Collection of IUpdateListener objects.
101: */
102: protected Collection getUpdateListeners() {
103: return m_updateListeners;
104: }
105:
106: /** Invokes the updateDone() method of the registered IUpdateListener objects in the same thread.
107: */
108: protected void invokeUpdateListeners() {
109: invokeUpdateListeners(null);
110: }
111:
112: /** Invokes the updateDone() method of the registered IUpdateListener objects in the same thread.
113: * @param eventObject The EventObject which will probably contain the component itself.
114: */
115: protected void invokeUpdateListeners(EventObject eventObject) {
116: if (m_updateListeners != null) {
117: if (eventObject == null)
118: eventObject = new EventObject(this );
119:
120: for (Iterator i = m_updateListeners.iterator(); i.hasNext();)
121: ((IUpdateListener) i.next()).updateDone(eventObject);
122: }
123: }
124:
125: }
|