KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > jegg > impl > MessageImpl


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 JEGG 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.impl;
30
31 import jegg.Message;
32 import jegg.Port;
33
34 /**
35  * Used to wrap an application message that is being sent from one egg to another.
36  * <p>
37  * The Message instance not wraps the sending egg's concrete message object, but
38  * also holds a reference to the sending egg's own message port and the
39  * priority of the message.
40  * <p>
41  * An egg can use a special base-class method, {@link jegg.Egg.ceateMessage(Object)
42  * Egg.createMessage()}, to wrap an application message before writing it to
43  * a message port.
44  */
45 public class MessageImpl implements Message
46 {
47     /** The message port of the sending egg */
48     private Port _from;
49     /** The sending egg's application message */
50     private Object JavaDoc _message;
51     /** The dispatch priority of the message */
52     private Priority _priority;
53     
54     /**
55      * Create a JEgg message.
56      *
57      * @param m the application message being sent.
58      * @param p the port of the sending egg.
59      * @param pr the message's dispatch priority.
60      */
61     public MessageImpl(Object JavaDoc m, Port p, Priority pr)
62     {
63         _from = p;
64         _message = m;
65         _priority = pr;
66     }
67     
68     /*
69      * (non-Javadoc)
70      * @see jegg.Message#getFrom()
71      */
72     public final Port getFrom()
73     {
74         return _from;
75     }
76
77     /*
78      * (non-Javadoc)
79      * @see jegg.Message#getMessage()
80      */
81     public final Object JavaDoc getMessage()
82     {
83         return _message;
84     }
85     
86     /*
87      * (non-Javadoc)
88      * @see jegg.Message#getPriority()
89      */
90     public final Priority getPriority()
91     {
92         return _priority;
93     }
94     
95     /*
96      * (non-Javadoc)
97      * @see java.lang.Object#toString()
98      */
99     public final String JavaDoc toString()
100     {
101         return "Message("+_message.toString()+")";
102     }
103 }
104
Popular Tags