XMLPropertySet

Class Overview

The XMLPropertySet behaves as an in-memory typed PropertySet, with the ability to load and save all the properties to/from an XML document.

• boolean, int, long, double and String properties are saved as simple Text nodes.
• text and XML properties are stored as CDATA blocks.
• java.util.Date properties are stored in yyyy-mm-dd HH:mm:ss format.
• java.util.Properties properties are stored in child elements.
• java.lang.Object and byte[] data properties are encoded using base64 into text and stored as CDATA blocks.

Example:

XMLPropertySet p = new XMLPropertySet(); // create blank property-set
p.load( new FileReader("my-properties.xml") ); // load properties from XML.
System.out.println( p.getString("name") );
p.setString("name","blah blah");
p.save( new FileWriter("my-properties.xml") ); // save properties back to XML.


Summary

[Expand] Inherited Constants

From interface com.opensymphony.module.propertyset.PropertySet int BOOLEAN Value-type boolean int DATA Value-type byte[] int DATE Value-type java.util.Date int DOUBLE Value-type double int INT Value-type int int LONG Value-type long int OBJECT Value-type serializable Object int PROPERTIES Value-type java.util.Properties int STRING Value-type String (max length 255) int TEXT Value-type text (unlimited length String) int XML Value-type XML org.w3c.dom.Document

[Expand] Inherited Fields
From class com.opensymphony.module.propertyset.AbstractPropertySet protected PropertySetSchema schema

[Expand] Inherited Methods
From class com.opensymphony.module.propertyset.memory.SerializablePropertySet HashMap getMap() void init(Map config, Map args) void remove() synchronized void setImpl(int type, String key, Object value)
From class com.opensymphony.module.propertyset.memory.MemoryPropertySet synchronized boolean exists(String key) synchronized Object get(int type, String key) synchronized Collection getKeys(String prefix, int type) HashMap getMap() synchronized int getType(String key) void init(Map config, Map args) void remove() synchronized void remove(String key) synchronized void setImpl(int type, String key, Object value)
From class com.opensymphony.module.propertyset.AbstractPropertySet abstract Object get(int type, String key) Object getAsActualType(String key) boolean getBoolean(String key) byte[] getData(String key) Casts to com.opensymphony.util.Data and returns bytes. Date getDate(String key) double getDouble(String key) int getInt(String key) Collection getKeys() Calls getKeys(null,0) Collection getKeys(int type) Calls getKeys(null,type) Collection getKeys(String prefix) Calls getKeys(prefix,0) long getLong(String key) Object getObject(String key) Properties getProperties(String key) PropertySetSchema getSchema() String getString(String key) String of maximum 255 chars. String getText(String key) String of unlimited length. Document getXML(String key) void init(Map config, Map args) boolean isSettable(String property) Returns true. void setAsActualType(String key, Object value) void setBoolean(String key, boolean value) void setData(String key, byte[] value) Constructs com.opensymphony.util.Data wrapper around bytes. void setDate(String key, Date value) void setDouble(String key, double value) abstract void setImpl(int type, String key, Object value) void setInt(String key, int value) void setLong(String key, long value) void setObject(String key, Object value) void setProperties(String key, Properties value) void setSchema(PropertySetSchema schema) void setString(String key, String value) Throws IllegalPropertyException if value length greater than 255. void setText(String key, String value) void setXML(String key, Document value) boolean supportsType(int type) Returns true. boolean supportsTypes() Returns true. String toString() Simple human readable representation of contents of PropertySet. int type(String type) String type(int type)
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface com.opensymphony.module.propertyset.PropertySet boolean exists(String key) Determine if property exists. Object getAsActualType(String key) boolean getBoolean(String key) byte[] getData(String key) Date getDate(String key) double getDouble(String key) int getInt(String key) Collection getKeys() List all keys. Collection getKeys(int type) List all keys of certain type. Collection getKeys(String prefix) List all keys starting with supplied prefix. Collection getKeys(String prefix, int type) List all keys starting with supplied prefix of certain type. long getLong(String key) Object getObject(String key) Properties getProperties(String key) PropertySetSchema getSchema() String getString(String key) String of maximum 255 chars. String getText(String key) String of unlimited length. int getType(String key) Returns type of value. Document getXML(String key) void init(Map config, Map args) boolean isSettable(String property) Whether this PropertySet implementation allows values to be set (as opposed to read-only). void remove() Remove the propertyset and all it associated keys. void remove(String key) Removes property. void setAsActualType(String key, Object value) void setBoolean(String key, boolean value) void setData(String key, byte[] value) void setDate(String key, Date value) void setDouble(String key, double value) void setInt(String key, int value) void setLong(String key, long value) void setObject(String key, Object value) void setProperties(String key, Properties value) void setSchema(PropertySetSchema schema) void setString(String key, String value) void setText(String key, String value) void setXML(String key, Document value) boolean supportsType(int type) Whether this PropertySet implementation allows the type specified to be stored or retrieved. boolean supportsTypes() Whether this PropertySet implementation supports types when storing values.