KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > jegg > Port


1 /*
2  * Copyright (c) 2004, Bruce Lowery
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * - Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  * - Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * - Neither the name of GOSSIP nor the names of its contributors may be used
14  * to endorse or promote products derived from this software without
15  * specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 package jegg;
30
31
32 /**
33  * An egg message port. Everyone egg has one message port that other eggs
34  * can use to send messages to the port's owner. To access another egg's
35  * port, declare a dependency on the other egg using the <uses> in
36  * the application descriptor. See the package documentation for the
37  * jegg.* package for more details.
38  */
39 public interface Port
40 {
41     /**
42      * Return the set of message types understood by the egg
43      * associated with this message port.
44      * @return non-null and non-empty array of class objects.
45      */
46     public Class JavaDoc[] getInterface();
47     
48     /**
49      * Deliver an object as a message to the egg that owns
50      * this port.
51      * @param o the object to send to this port's owner. The
52      * object will be delivered wrapped in a Message instance.
53      */
54     public void send(final Object JavaDoc o) throws PortException;
55
56     /**
57      * Deliver a message to the egg that owns this port.
58      * @param o the object to deliver to the egg.
59      * @param p the prioroty of the message.
60      */
61     public void send(final Message m) throws PortException;
62     
63     /**
64      * Return the ID of the egg that owns this port.
65      */
66     public Object JavaDoc getId();
67 }
Popular Tags