oracle.adf.share.sandbox

Class XmlArchivedProperties

java.lang.Object

oracle.adf.share.sandbox.XmlArchivedProperties

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AdfMdeTesterResult, MutableProperties, SandboxArchive

public class XmlArchivedProperties
extends java.lang.Object
implements java.io.Serializable

A set of persisted properties usually interpreted by tools that administer sandboxes.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XmlArchivedProperties() Constructs an empty property map.
	XmlArchivedProperties(XmlArchivedProperties p) Constructs a new XmlArchivedProperties and copies all properties from another XmlArchivedProperties.

Method Summary

Modifier and Type	Method and Description
boolean	containsName(java.lang.String name) Returns true if the property by a certain name exists.
static XmlArchivedProperties	fromXml(java.lang.String xml) Decodes an XML document encoded by toXml.
java.math.BigDecimal	getBigDecimal(java.lang.String name) Returns the value of the property specified by a name as a BigDecimal number.
java.math.BigInteger	getBigInteger(java.lang.String name) Returns the value of the property specified by a name as a BigInteger number.
java.lang.Boolean	getBoolean(java.lang.String name) Returns the value of the property specified by a name as a Boolean.
java.util.Date	getDate(java.lang.String name) Returns the value of the property specified by a name as a java.util.Date.
java.lang.Double	getDouble(java.lang.String name) Returns the value of the property specified by a name as a Double number.
java.lang.Integer	getInteger(java.lang.String name) Returns the value of the property specified by a name as an Integer number.
java.lang.Long	getLong(java.lang.String name) Returns the value of the property specified by a name as a Long number.
java.lang.Long[]	getLongArray(java.lang.String name) Returns the value of the property specified by a name as a Long array.
java.lang.Object	getObject(java.lang.String name) Returns the value of the property specified by a name.
java.lang.String	getString(java.lang.String name) Returns the value of the property specified by a name as a String.
java.lang.String[]	getStringArray(java.lang.String name) Returns the value of the property specified by a name as a String array.
XmlArchivedProperties	getXmlArchivedProperties(java.lang.String name) Returns the value of the property specified by a name as an XmlArchivedProperties object.
XmlArchivedProperties[]	getXmlArchivedPropertiesArray(java.lang.String name) Returns the value of the property specified by a name as an XmlArchivedProperties array.
java.util.Set<java.lang.String>	propertyNameSet() Returns the property names in this collection.
protected void	remove(java.lang.String name) Removes a property.
protected void	setBigDecimal(java.lang.String name, java.math.BigDecimal value) Sets the value of a property.
protected void	setBigInteger(java.lang.String name, java.math.BigInteger value) Sets the value of a property.
protected void	setBoolean(java.lang.String name, boolean b) Sets the value of a property.
protected void	setDate(java.lang.String name, java.util.Date date) Sets the value of a property.
protected void	setDouble(java.lang.String name, java.lang.Double value) Sets the value of a property.
protected void	setInteger(java.lang.String name, java.lang.Integer value) Sets the value of a property.
protected void	setLong(java.lang.String name, java.lang.Long value) Sets the value of a property.
protected void	setLongArray(java.lang.String name, java.lang.Long[] value) Sets the value of a property.
protected void	setString(java.lang.String name, java.lang.String value) Sets the value of a property.
protected void	setStringArray(java.lang.String name, java.lang.String[] value) Sets the value of a property.
protected void	setXmlArchivedProperties(java.lang.String name, XmlArchivedProperties value) Sets the value of a property.
protected void	setXmlArchivedPropertiesArray(java.lang.String name, XmlArchivedProperties[] value) Sets the value of a property.
int	size() Returns the number of properties in this collection.
java.lang.String	toString()
static java.lang.String	toXml(XmlArchivedProperties properties) Encodes a XmlArchivedProperties object in the form of XML.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlArchivedProperties

protected XmlArchivedProperties()

Constructs an empty property map.

XmlArchivedProperties

public XmlArchivedProperties(XmlArchivedProperties p)

Constructs a new XmlArchivedProperties and copies all properties from another XmlArchivedProperties.

Parameters:

p - the properties to be copied

Throws:

java.lang.NullPointerException - if the given argument is null

Method Detail

toXml

public static final java.lang.String toXml(XmlArchivedProperties properties)

Encodes a XmlArchivedProperties object in the form of XML.

Parameters:

properties - the XmlArchivedProperties object to be encoded

Returns:

the XML document

Throws:

java.lang.IllegalArgumentException - if the given object is null or contains any cyclic references

See Also:

fromXml(java.lang.String)

fromXml

public static final XmlArchivedProperties fromXml(java.lang.String xml)

Decodes an XML document encoded by toXml.

Parameters:

xml - the XML document

Returns:

an object of this class

Throws:

java.lang.IllegalArgumentException - if the given XML document is null or empty

See Also:

toXml(oracle.adf.share.sandbox.XmlArchivedProperties)

getObject

public java.lang.Object getObject(java.lang.String name)

Returns the value of the property specified by a name. If the value is an array, a copy of the array is returned.

Parameters:

name - the property name

Returns:

the value of the property specified by the name; null if the property does not exist, or if the property value is null

containsName

public boolean containsName(java.lang.String name)

Returns true if the property by a certain name exists.

Parameters:

name - the name of the property

Returns:

true if the property by the given name exists

setXmlArchivedProperties

protected void setXmlArchivedProperties(java.lang.String name,
                                        XmlArchivedProperties value)

Sets the value of a property.

Parameters:

name - the property name

value - the property value

getXmlArchivedProperties

public XmlArchivedProperties getXmlArchivedProperties(java.lang.String name)

Returns the value of the property specified by a name as an XmlArchivedProperties object.

Parameters:

name - the property name

Returns:

the value of the property specified by the name; null if the property does not exist, or if the property value is null

Throws:

java.lang.ClassCastException - if the property value is not an XmlArchivedProperties object

setXmlArchivedPropertiesArray

protected void setXmlArchivedPropertiesArray(java.lang.String name,
                                             XmlArchivedProperties[] value)

Sets the value of a property.

Parameters:

name - the property name

value - the property value

getXmlArchivedPropertiesArray

public XmlArchivedProperties[] getXmlArchivedPropertiesArray(java.lang.String name)

Returns the value of the property specified by a name as an XmlArchivedProperties array.

Parameters:

name - the property name

Returns:

the value of the property specified by the name; null if the property does not exist, or if the property value is null

Throws:

java.lang.ClassCastException - if the property value is not an XmlArchivedProperties array

setInteger

protected void setInteger(java.lang.String name,
                          java.lang.Integer value)

Sets the value of a property.

Parameters:

name - the property name

value - the property value

getInteger

public java.lang.Integer getInteger(java.lang.String name)

Returns the value of the property specified by a name as an Integer number.

Parameters:

name - the property name

Returns:

the value of the property specified by the name; null if the property does not exist, or if the property value is null

Throws:

java.lang.ClassCastException - if the property value is not an Integer number

setLong

protected void setLong(java.lang.String name,
                       java.lang.Long value)

Sets the value of a property.

Parameters:

name - the property name

value - the property value

getLong

public java.lang.Long getLong(java.lang.String name)

Returns the value of the property specified by a name as a Long number.

Parameters:

name - the property name

Returns:

the value of the property specified by the name; null if the property does not exist, or if the property value is null

Throws:

java.lang.ClassCastException - if the property value is not a Long number

setLongArray

protected void setLongArray(java.lang.String name,
                            java.lang.Long[] value)

Sets the value of a property.

Parameters:

name - the property name

value - the property value

getLongArray

public java.lang.Long[] getLongArray(java.lang.String name)

Returns the value of the property specified by a name as a Long array.

Parameters:

name - the property name

Returns:

the value of the property specified by the name; null if the property does not exist, or if the property value is null

Throws:

java.lang.ClassCastException - if the property value is not a Long array

setDouble

protected void setDouble(java.lang.String name,
                         java.lang.Double value)

Sets the value of a property.

Parameters:

name - the property name

value - the property value

getDouble

public java.lang.Double getDouble(java.lang.String name)

Returns the value of the property specified by a name as a Double number.

Parameters:

name - the property name

Returns:

the value of the property specified by the name; null if the property does not exist, or if the property value is null

Throws:

java.lang.ClassCastException - if the property value is not a Double number

setBigInteger

protected void setBigInteger(java.lang.String name,
                             java.math.BigInteger value)

Sets the value of a property.

Parameters:

name - the property name

value - the property value

getBigInteger

public java.math.BigInteger getBigInteger(java.lang.String name)

Returns the value of the property specified by a name as a BigInteger number.

Parameters:

name - the property name

Returns:

the value of the property specified by the name; null if the property does not exist, or if the property value is null

Throws:

java.lang.ClassCastException - if the property value is not a BigInteger number

setBigDecimal

protected void setBigDecimal(java.lang.String name,
                             java.math.BigDecimal value)

Sets the value of a property.

Parameters:

name - the property name

value - the property value

getBigDecimal

public java.math.BigDecimal getBigDecimal(java.lang.String name)

Returns the value of the property specified by a name as a BigDecimal number.

Parameters:

name - the property name

Returns:

the value of the property specified by the name; null if the property does not exist, or if the property value is null

Throws:

java.lang.ClassCastException - if the property value is not a BigDecimal number

setString

protected void setString(java.lang.String name,
                         java.lang.String value)

Sets the value of a property.

Parameters:

name - the property name

value - the property value

getString

public java.lang.String getString(java.lang.String name)

Returns the value of the property specified by a name as a String.

Parameters:

name - the property name

Returns:

the value of the property specified by the name; null if the property does not exist, or if the property value is null

Throws:

java.lang.ClassCastException - if the property value is not a String

setBoolean

protected void setBoolean(java.lang.String name,
                          boolean b)

Sets the value of a property.

Parameters:

name - the property name

b - the property value

getBoolean

public java.lang.Boolean getBoolean(java.lang.String name)

Returns the value of the property specified by a name as a Boolean.

Parameters:

name - the property name

Returns:

the value of the property specified by the name; null if the property does not exist, or if the property value is null

Throws:

java.lang.ClassCastException - if the property value is not a Boolean

setDate

protected void setDate(java.lang.String name,
                       java.util.Date date)

Sets the value of a property.

Parameters:

name - the property name

date - the property value

getDate

public java.util.Date getDate(java.lang.String name)

Returns the value of the property specified by a name as a java.util.Date.

Parameters:

name - the property name

Returns:

the value of the property specified by the name; null if the property does not exist, or if the property value is null

Throws:

java.lang.ClassCastException - if the property value is not a java.util.Date

setStringArray

protected void setStringArray(java.lang.String name,
                              java.lang.String[] value)

Sets the value of a property. The given array is not copied. Any update to the array will be visible.

Parameters:

name - the property name

value - the property value

getStringArray

public java.lang.String[] getStringArray(java.lang.String name)

Returns the value of the property specified by a name as a String array.

Parameters:

name - the property name

Returns:

the value of the property specified by the name; null if the property does not exist, or if the property value is null

Throws:

java.lang.ClassCastException - if the property value is not a String array

remove

protected void remove(java.lang.String name)

Removes a property.

Parameters:

name - the name of the property

propertyNameSet

public java.util.Set<java.lang.String> propertyNameSet()

Returns the property names in this collection.

Returns:

the property names in this collection

size

public int size()

Returns the number of properties in this collection.

Returns:

the number of properties in this collection

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object