cms/util/XMLPacket.java

//---PACKAGE DECLARATION---
package uk.ac.ukc.iscream.util;

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

/**
 * Object in which to store incoming XML data
 * to be passed around the CORBA system.
 *
 * @author  $Author: pjm2 $
 * @version $Id: XMLPacket.java,v 1.6 2000/12/01 14:42:04 pjm2 Exp $
 */
public class XMLPacket {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.6 $";
    
//---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();
    }
    
    // Print out the entire HashMap.
    // (Mainly for assisting debugging.)
    public synchronized String printAll () {
        return _params.toString();
    }

    /**
     * Overrides the {@link java.lang.Object#toString() Object.toString()}
     * method to provide clean logging (every class should have this).
     *
     * @return the name of this class and its CVS revision
     */
    public String toString () {
        return this.getClass().getName() + "(" + REVISION.substring(11, REVISION.length() - 2) + ")";
    }

//---PRIVATE METHODS---

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

//---ATTRIBUTES---

    private HashMap _params = new HashMap();

//---STATIC ATTRIBUTES---

}
Revision:	1.7
Committed:	Tue Dec 5 12:26:22 2000 UTC (23 years, 4 months ago) by pjm2
Branch:	MAIN
Changes since 1.6:	+10 -5 lines
Log Message:	Added an include to java.util.* and a new method that returns a set of all keys in the XMLPacket.
#	User	Rev	Content
1	tdb	1.3	//---PACKAGE DECLARATION---
2	ajm	1.5	package uk.ac.ukc.iscream.util;
3	tdb	1.3
4			//---IMPORTS---
5	pjm2	1.7	import java.util.*;
6	pjm2	1.1
7	tdb	1.3	/**
8			* Object in which to store incoming XML data
9			* to be passed around the CORBA system.
10			*
11	pjm2	1.7	* @author $Author: pjm2 $
12			* @version $Id: XMLPacket.java,v 1.6 2000/12/01 14:42:04 pjm2 Exp $
13	tdb	1.3	*/
14			public class XMLPacket {
15
16			//---FINAL ATTRIBUTES---
17
18			/**
19			* The current CVS revision of this class
20			*/
21	pjm2	1.7	public final String REVISION = "$Revision: 1.6 $";
22	tdb	1.3
23			//---STATIC METHODS---
24
25			//---CONSTRUCTORS---
26	pjm2	1.1
27	tdb	1.3	//---PUBLIC METHODS---
28	pjm2	1.1
29			// Add a key and value pair to the HashMap.
30			public synchronized void addParam (String key, String value) {
31	pjm2	1.6	_params.put(key, value);
32	pjm2	1.1	}
33
34			// Return the value associated with a particular key.
35			// Returns null if the key does not exist, although
36			// this should not necessarily indicate that the key
37			// does not exist.
38			public synchronized String getParam (String key) {
39	tdb	1.4	return (String) _params.get(key);
40	pjm2	1.1	}
41
42	pjm2	1.7	// Return a Set of the keys in the HashMap.
43			public synchronized Set getSet () {
44			return _params.keySet();
45			}
46
47	pjm2	1.1	// Print out the entire HashMap.
48			// (Mainly for assisting debugging.)
49	pjm2	1.2	public synchronized String printAll () {
50	tdb	1.4	return _params.toString();
51	pjm2	1.1	}
52
53	tdb	1.3	/**
54			* Overrides the {@link java.lang.Object#toString() Object.toString()}
55			* method to provide clean logging (every class should have this).
56			*
57			* @return the name of this class and its CVS revision
58			*/
59	pjm2	1.7	public String toString () {
60	tdb	1.3	return this.getClass().getName() + "(" + REVISION.substring(11, REVISION.length() - 2) + ")";
61			}
62
63			//---PRIVATE METHODS---
64
65			//---ACCESSOR/MUTATOR METHODS---
66
67			//---ATTRIBUTES---
68
69	tdb	1.4	private HashMap _params = new HashMap();
70	tdb	1.3
71			//---STATIC ATTRIBUTES---
72
73	pjm2	1.6	}