1 /*
2 * jDTAUS Core API
3 * Copyright (C) 2005 Christian Schulte
4 * <cs@schulte.it>
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 *
20 */
21 package org.jdtaus.core.text;
22
23 /**
24 * {@code MessageEventSource} is implemented by classes firing
25 * {@code MessageEvent}s.
26 * <p>Example: Listening to all jDTAUS Core SPI compliant implementations in the
27 * system<blockquote><pre>
28 * MessageEventSource source =
29 * (MessageEventSource) ContainerFactory.getContainer().
30 * getObject( MessageEventSource.class );
31 *
32 * source.addMessageListener(<i>your application's listener</i>);
33 * </pre></blockquote></p>
34 *
35 * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
36 * @version $JDTAUS: MessageEventSource.java 8641 2012-09-27 06:45:17Z schulte $
37 */
38 public interface MessageEventSource
39 {
40 //--MessageEventSource------------------------------------------------------
41
42 /**
43 * Adds a {@code MessageListener} to the listener list.
44 *
45 * @param listener The listener to be added to the listener list.
46 *
47 * @throws NullPointerException if {@code listener} is {@code null}.
48 */
49 void addMessageListener( MessageListener listener );
50
51 /**
52 * Removes a {@code MessageListener} from the listener list.
53 *
54 * @param listener The listener to be removed from the listener list.
55 *
56 * @throws NullPointerException if {@code listener} is {@code null}.
57 */
58 void removeMessageListener( MessageListener listener );
59
60 /**
61 * Gets all currently registered {@code MessageListener}s.
62 *
63 * @return all currently registered {@code MessageListener}s.
64 */
65 MessageListener[] getMessageListeners();
66
67 //------------------------------------------------------MessageEventSource--
68 }