01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * 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: 57198 $
43: */
44: public interface Receivers {
45:
46: /**
47: * @return Get the number of receivers
48: */
49: int size();
50:
51: /**
52: * @return the subscriptions as an array list, this must be a
53: * clone of any internal datastructure
54: */
55: ArrayList listReceivers();
56:
57: /**
58: * Add a receiver, ignored if the receiver is already present.
59: *
60: * @param sub the receiver to add
61: */
62: void add(Subscription sub);
63:
64: /**
65: * Remove a receiver
66: *
67: * @param sub the receiver to remove
68: */
69: void remove(Subscription sub);
70:
71: /**
72: * Get an iterator to loop over all receivers
73: *
74: * @return the iterator
75: */
76: Iterator iterator();
77: }
|