Receivers


1   /*
2   * JBoss, Home of Professional Open Source
3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
4   * by the @authors tag. See the copyright.txt in the distribution for a
5   * full listing of individual contributors.
6   *
7   * This is free software; you can redistribute it and/or modify it
8   * under the terms of the GNU Lesser General Public License as
9   * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * This software is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this software; if not, write to the Free
19  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21  */
22  package org.jboss.mq.server;
23  
24  import java.util.ArrayList  ;
25  import java.util.Iterator  ;
26  
27  import org.jboss.mq.Subscription;
28  
29  /**
30   * Interface to be implemented by a receivers implementation.
31   * The implementation should also have a default constructor.<p>
32   * 
33   * NOTE: There is no need to internally synchronize the caller
34   * handles that.<p>
35   * 
36   * NOTE: This datastructure should have Set semantics. 
37   *       i.e. attempts to add a subscriber that is already
38   *       present should be ignored. Or more explicitly
39   *       a subscriber should present zero or once. 
40   *
41   * @author <a HREF="mailto:adrian@jboss.com">Adrian Brock</a>
42   * @version $Revision: 38548 $
43   */
44  public interface Receivers
45  {
46  
47     /**
48      * @return Get the number of receivers
49      */
50     int size();
51     
52     /**
53      * @return the subscriptions as an array list, this must be a
54      * clone of any internal datastructure
55      */
56     ArrayList   listReceivers();
57     
58     
59     /**
60      * Add a receiver, ignored if the receiver is already present.
61      * 
62      * @param sub the receiver to add
63      */
64     void add(Subscription sub);
65     
66     /**
67      * Remove a receiver
68      * 
69      * @param sub the receiver to remove
70      */
71     void remove(Subscription sub);
72     
73     /**
74      * Get an iterator to loop over all receivers
75      * 
76      * @return the iterator
77      */
78     Iterator   iterator();
79  }
80
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags