pureweb.xml

Class XmlStateLock

java.lang.Object

pureweb.xml.XmlStateLock

public class XmlStateLock
extends java.lang.Object

The XmlStateLock class provides methods to interact with the PureWeb application state, once you have acquired a state lock. Instances of XmlStateLock are obtained by calling acquireLock. Instances of XmlStateLock provide thread-safe read/write access to XML state.

When referring to a value in the application state tree, provide the entire path (except for the root element, which should be omitted), dividing each level using a slash, for example: /MainPage/TabX/ControlName.

The path can also contain conditional operators:

• /Definitions/#1 (first ordered child of an element called Definitions)
• /Definition[Id=1;Type=Button] (a Definition element with Id of 1 and of type Button)

Method Summary

Modifier and Type	Method and Description
org.jdom.Element	getTree(java.lang.String path) Returns the element at the specified path in the application state tree.
org.jdom.Element	getTree(java.lang.String path, boolean allowCreate) Returns the element at the specified location, or null if it does not exist.
java.lang.String	getValue(java.lang.String path) Returns the value of the element at the specified path in the a application state tree.
java.lang.Object	getValueAs(java.lang.Class cls, java.lang.String path) Returns the value of the element at the specified path in the application state tree.
java.lang.Object	getValueAs(java.lang.Class cls, java.lang.String path, java.lang.Object defaultValue) Returns the value of the element at the specified path in the application state tree.
void	release() Releases the lock on application state.
void	setTree(java.lang.String path, org.jdom.Element element) Replaces or inserts the section of application state at and below the specified path.
void	setValue(java.lang.String path, java.lang.Object value) Sets the value of the element at the specified path in the application state tree.
java.lang.String	toString() Returns the entire application state tree, expressed as a string.

Methods inherited from class java.lang.Object

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

Method Detail

toString

public java.lang.String toString()

Returns the entire application state tree, expressed as a string.

Overrides:

toString in class java.lang.Object

getValue

public java.lang.String getValue(java.lang.String path)

Returns the value of the element at the specified path in the a application state tree. Will return null if the element does not exist.

setValue

public void setValue(java.lang.String path,
                     java.lang.Object value)

Sets the value of the element at the specified path in the application state tree.

getValueAs

public java.lang.Object getValueAs(java.lang.Class cls,
                                   java.lang.String path)

Returns the value of the element at the specified path in the application state tree. The value will be returned in the specified data type. Will throw InvalidCastException if the value does not exist or cannot be converted.

getValueAs

public java.lang.Object getValueAs(java.lang.Class cls,
                                   java.lang.String path,
                                   java.lang.Object defaultValue)

Returns the value of the element at the specified path in the application state tree. The value will be returned in the specified data type. Will return the specified default if the value does not exist or cannot be converted.

Parameters:

cls - The Class the type T.

path - The path.

defaultValue - The default value.

getTree

public org.jdom.Element getTree(java.lang.String path)

Returns the element at the specified path in the application state tree. This element may not be valid after the lock is released.

getTree

public org.jdom.Element getTree(java.lang.String path,
                                boolean allowCreate)

Returns the element at the specified location, or null if it does not exist. The copy is created if allowCreate is set to true, otherwise will return null.

release

public void release()

Releases the lock on application state.

setTree

public void setTree(java.lang.String path,
                    org.jdom.Element element)

Replaces or inserts the section of application state at and below the specified path.