org.opengis.cite.securityclient10.util

Class PropertiesDocument

java.lang.Object

org.opengis.cite.securityclient10.util.PropertiesDocument

public class PropertiesDocument
extends Object

Class to wrap a Document that is of the XML Properties schema. Useful for reading/writing Documents without having to create your own DocumentBuilders.

Constructor Summary

Constructors

Constructor and Description
PropertiesDocument() Create blank PropertiesDocument with blank Properties object
PropertiesDocument(Document testRunArgs) Create a Properties Document using the input as the existing Document.
PropertiesDocument(File xmlFile) Create a Properties Document from an input XML file

Method Summary

Modifier and Type	Method and Description
Document	getDocument() Create a Document corresponding to the internal Properties object.
Properties	getProperties() Return the Properties object
String	getProperty(String key) Return a value for a key in the Properties object
void	removeProperty(String key) Delete a key and its value from the Properties object
void	setProperty(String key, String value) Update a value in the Properties object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropertiesDocument

public PropertiesDocument()

Create blank PropertiesDocument with blank Properties object

PropertiesDocument

public PropertiesDocument(File xmlFile)
                   throws ParserConfigurationException,
                          SAXException,
                          IOException

Create a Properties Document from an input XML file

Parameters:

xmlFile - File to open for parsing

Throws:

SAXException - Exception on parsing input as XML

IOException - Exception if XML could not be read for properties file

ParserConfigurationException - Exception if Document Builder could not be created

InvalidPropertiesFormatException - Exception if XML is not in Properties format

PropertiesDocument

public PropertiesDocument(Document testRunArgs)
                   throws ParserConfigurationException

Create a Properties Document using the input as the existing Document.

Parameters:

testRunArgs - Document to use as base

Throws:

ParserConfigurationException - Exception if Document Builder could not be created

Method Detail

getDocument

public Document getDocument()

Create a Document corresponding to the internal Properties object. Note: You must manually set the SYSTEM DocType to "http://java.sun.com/dtd/properties.dtd" when transforming this Document.

Returns:

Document with Properties format

getProperties

public Properties getProperties()

Return the Properties object

Returns:

Properties object

getProperty

public String getProperty(String key)

Return a value for a key in the Properties object

Parameters:

key - String with key name

Returns:

String with value

removeProperty

public void removeProperty(String key)

Delete a key and its value from the Properties object

Parameters:

key - The key to remove

setProperty

public void setProperty(String key,
                        String value)

Update a value in the Properties object

Parameters:

key - String with key name

value - String with value