KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > enterprise > admin > common > Message


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */
23
24 package com.sun.enterprise.admin.common;
25
26 //JDK imports
27 import java.io.Serializable JavaDoc;
28
29
30
31 /**
32     Base class for generic message exchange where messages are
33     modeled as a list of parameters. There is no explicit type
34     to the message, just the list ParamList.
35 */
36 public class Message implements Serializable JavaDoc
37 {
38     public static long serialVersionUID = 1974497368816731621L;
39
40     private ParamList mParams = null;
41
42         /**
43             The default constructor.
44         */
45         
46     public Message()
47     {
48         mParams = new ParamList();
49     }
50
51         /**
52             Adds the given parameter in this Message.
53         */
54     public void addParam( Param param )
55     {
56         mParams.addParam( param );
57     }
58
59     public Param getParam( String JavaDoc name )
60     {
61         return( mParams.getParam( name ) );
62     }
63
64
65     // caller should not treat list as read-only
66 /**
67         Returns the list of Param objects. The list can be modified.
68      
69         @return ParamList instance held by this Message.
70     */
71     public ParamList getParamList()
72     {
73         return( mParams );
74     }
75
76     public String JavaDoc toString()
77     {
78         return( mParams.toString() );
79     }
80 }
Popular Tags