client/javacli/XMLPacket.java

/* 
 * i-scream central monitoring system
 * http://www.i-scream.org.uk
 * Copyright (C) 2000-2002 i-scream
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

//---PACKAGE DECLARATION---

//---IMPORTS---
import java.util.*;

/**
 * Object in which to store incoming XML data
 * to be provided to the CLI CLient.
 *
 * @author  $Author: tdb $
 * @version $Id: XMLPacket.java,v 1.3 2002/05/21 16:47:11 tdb Exp $
 */
public class XMLPacket {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.3 $";
    
//---STATIC METHODS---

//---CONSTRUCTORS---

//---PUBLIC METHODS---

    /**
     * Add a key and value pair to the HashMap.
     */
    public synchronized void addParam (String key, String value) {
        _params.put(key, value);
    }
    
    /**
     * Return the value associated with a particular key.
     * Returns null if the key does not exist, although
     * this should not necessarily indicate that the key
     * does not exist.
     */
    public synchronized String getParam (String key) {
        return (String) _params.get(key);
    }
    
    /**
     * Return a Set of the keys in the HashMap.
     */
    public synchronized Set getSet () {
        return _params.keySet();
    }
    
    /**
     * Find if a particular key exists in the HashMap.
     */
    public synchronized boolean containsKey(String key){
        return _params.containsKey(key);
    }
    
    /**
     * Print out the entire HashMap.
     * (Mainly for assisting debugging.)
     */
    public synchronized String printAll () {
        return _params.toString();
    }


//---PRIVATE METHODS---

//---ACCESSOR/MUTATOR METHODS---

//---ATTRIBUTES---

    private HashMap _params = new HashMap();

//---STATIC ATTRIBUTES---

}
Revision:	1.4
Committed:	Mon Jun 10 14:10:43 2002 UTC (22 years, 5 months ago) by tdb
Branch:	MAIN
CVS Tags:	HEAD
Changes since 1.3:	+2 -2 lines
State:	*FILE REMOVED*
Log Message:	Tidy up of files. These are all old things that are not only no longer used but are also probably useless to anyone other than us. This saves checking them out all the time, and makes the "cms/source" tree contain only current stuff. They'll still exist in the attic's though :)
#	Content
1	/*
2	* i-scream central monitoring system
3	* http://www.i-scream.org.uk
4	* Copyright (C) 2000-2002 i-scream
5	*
6	* This program is free software; you can redistribute it and/or
7	* modify it under the terms of the GNU General Public License
8	* as published by the Free Software Foundation; either version 2
9	* of the License, or (at your option) any later version.
10	*
11	* This program is distributed in the hope that it will be useful,
12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14	* GNU General Public License for more details.
15	*
16	* You should have received a copy of the GNU General Public License
17	* along with this program; if not, write to the Free Software
18	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19	*/
20
21	//---PACKAGE DECLARATION---
22
23	//---IMPORTS---
24	import java.util.*;
25
26	/**
27	* Object in which to store incoming XML data
28	* to be provided to the CLI CLient.
29	*
30	* @author $Author: tdb $
31	* @version $Id: XMLPacket.java,v 1.3 2002/05/21 16:47:11 tdb Exp $
32	*/
33	public class XMLPacket {
34
35	//---FINAL ATTRIBUTES---
36
37	/**
38	* The current CVS revision of this class
39	*/
40	public final String REVISION = "$Revision: 1.3 $";
41
42	//---STATIC METHODS---
43
44	//---CONSTRUCTORS---
45
46	//---PUBLIC METHODS---
47
48	/**
49	* Add a key and value pair to the HashMap.
50	*/
51	public synchronized void addParam (String key, String value) {
52	_params.put(key, value);
53	}
54
55	/**
56	* Return the value associated with a particular key.
57	* Returns null if the key does not exist, although
58	* this should not necessarily indicate that the key
59	* does not exist.
60	*/
61	public synchronized String getParam (String key) {
62	return (String) _params.get(key);
63	}
64
65	/**
66	* Return a Set of the keys in the HashMap.
67	*/
68	public synchronized Set getSet () {
69	return _params.keySet();
70	}
71
72	/**
73	* Find if a particular key exists in the HashMap.
74	*/
75	public synchronized boolean containsKey(String key){
76	return _params.containsKey(key);
77	}
78
79	/**
80	* Print out the entire HashMap.
81	* (Mainly for assisting debugging.)
82	*/
83	public synchronized String printAll () {
84	return _params.toString();
85	}
86
87
88	//---PRIVATE METHODS---
89
90	//---ACCESSOR/MUTATOR METHODS---
91
92	//---ATTRIBUTES---
93
94	private HashMap _params = new HashMap();
95
96	//---STATIC ATTRIBUTES---
97
98	}