Source code: mobile/protocol/Frame.java
1 /** Java class "Frame.java" generated from Poseidon for UML.
2 * Poseidon for UML is developed by <A HREF="http://www.gentleware.com">Gentleware</A>.
3 * Generated with <A HREF="http://jakarta.apache.org/velocity/">velocity</A> template engine.
4 */
5
6 package mobile.protocol;
7
8 //import mobile.bearer.http.Protocol;
9
10
11 /**
12 * <p>
13 * The Frame class is an abstract class implementing a message which is sent
14 * between the library and the proxy server. The message concerns a JMS action
15 * such as creation of a new JMS object on the mobile device, a call of a JMS
16 * method on this object or a JNDI action, such as a lookup of a JMS administered
17 * object.
18 * </p>
19 * @author Pawel Koziol
20 */
21 public class Frame implements mobile.bearer.http.Protocol {
22
23 ///////////////////////////////////////
24 // attributes
25
26 /**
27 * <p>
28 * Reference to the previous frame in the frame queue
29 * </p>
30 */
31 private Frame prev = null;
32
33 /**
34 * <p>
35 * Reference to the next frame in the queue
36 * </p>
37 */
38 private Frame next = null;
39
40 /**
41 <p>
42 accessor method for the next frame
43 </p>
44 @return returns a reference to the next frame in the queue
45 */
46 public Frame getNext(){
47 return next;
48 }
49
50 /**
51 <p>
52 accessor method for the previous frame
53 </p>
54 @return returns a reference to the orevious frame in the queue
55 */
56 public Frame getPrev(){
57 return prev;
58 }
59
60 /**
61 <p>
62 accessor method for the next frame
63 </p>
64 @param newFrame new value of the next frame in the queue
65 */
66 public void setNext(Frame newFrame){
67 next = newFrame;
68 }
69
70 /**
71 <p>
72 accessor method for the next frame
73 </p>
74 @param newFrame new value of the previous frame in the queue
75 */
76 public void setPrev(Frame newFrame){
77 prev = newFrame;
78 }
79
80 /**
81 * <p>
82 * Represents the code of the message contained in the Frame according to the
83 * Protocol interface.
84 * @see mobile.bearer.http.Protocol
85 * </p>
86 */
87 public int code;
88
89 /**
90 * <p>
91 * Represents the id of calling MIDlet
92 * </p>
93 *
94 */
95 public int owner;
96
97 /**
98 * <p>
99 * message data
100 * </p>
101 */
102 private Object[] data;
103
104
105 /**
106 * <p>
107 * A unique id of this Frame on this mobile device.
108 * </p>
109 */
110 public int id;
111
112 ///////////////////////////////////////
113 // operations
114
115
116
117 /**
118 * <p>
119 * Returns objects contained in this frame. These objects are needed to
120 * execute the method associated with this frame.
121 * </p><p>
122 *
123 * @return a Object[] with objects contained in this frame.
124 * </p>
125 */
126 public Object[] getData() {
127 return data;
128 } // end getData
129
130 /**
131 * <p>
132 * Sets the objects associated with this frame.
133 * </p><p>
134 *
135 * </p><p>
136 *
137 * @param _data Objects to be stored in this frame.
138 * </p>
139 */
140 public void setData(Object[] _data) {
141 data = _data;
142 } // end setData
143
144 } // end Frame
145
146
147
148
149