Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> aendvari >> common >> [ properties overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.aendvari.common.properties
Class Properties  

java.lang.Object
  com.aendvari.common.osm.OsmNode
      com.aendvari.common.osm.Osm
          com.aendvari.common.properties.Properties

---

public class Properties

extends com.aendvari.common.osm.Osm

Provides the ability to store property values in a hierarchy.

This class extends the Object Space Model (com.aendvari.common.osm.Osm) class.

Native types may be stored using the accessors provided. The methods will translate to and from their Object class equivalents.

---

Field Summary

 

Fields inherited from class com.aendvari.common.osm.OsmNode

attributes, children, name, parent, position, value

 

Constructor Summary

Properties()           Constructs a Properties instance.

Properties(Properties source)           Constructs a Properties instance from another Properties.

 

Method Summary
void	clearProperties()           Clears (removes) all properties.
Properties	cloneProperties()           Returns a duplicate of this Properties.
void	cloneProperties(Properties source)           Duplicates the supplied Properties.
boolean	getBoolean(java.lang.String path)           Returns the boolean value of the specified property.
byte	getByte(java.lang.String path)           Returns the byte value of the specified property.
double	getDouble(java.lang.String path)           Returns the double value of the specified property.
float	getFloat(java.lang.String path)           Returns the float value of the specified property.
int	getInt(java.lang.String path)           Returns the int value of the specified property.
long	getLong(java.lang.String path)           Returns the long value of the specified property.
java.lang.Object	getObject(java.lang.String path)           Returns the Object value of the specified property.
protected  void	getProperties(java.util.Collection nodes, boolean includeChildren, java.util.Map result)           Selects the properties specified by the query expression.
java.util.Map	getProperties(java.lang.String expression, boolean includeChildren)           Selects the properties specified by the query expression.
short	getShort(java.lang.String path)           Returns the short value of the specified property.
java.lang.String	getString(java.lang.String path)           Returns the String value of the specified property.
boolean	propertyExists(java.lang.String path)           Returns true if the specified property exists.
void	removeProperty(java.lang.String path)           Removes the specified property and all of its children.
void	setBoolean(java.lang.String path, boolean value)           Sets the boolean value of the specified property.
void	setByte(java.lang.String path, byte value)           Sets the byte value of the specified property.
void	setDouble(java.lang.String path, double value)           Sets the double value of the specified property.
void	setFloat(java.lang.String path, float value)           Sets the float value of the specified property.
void	setInt(java.lang.String path, int value)           Sets the int value of the specified property.
void	setLong(java.lang.String path, long value)           Sets the long value of the specified property.
void	setObject(java.lang.String path, java.lang.Object value)           Sets the Object value of the specified property.
void	setShort(java.lang.String path, short value)           Sets the short value of the specified property.
void	setString(java.lang.String path, java.lang.String value)           Sets the String value of the specified property.

 

Methods inherited from class com.aendvari.common.osm.Osm

cloneOsm, cloneOsm, createNode, createNode, createNode

 

Methods inherited from class com.aendvari.common.osm.OsmNode

appendChild, cloneNode, getAllChildNodes, getAllChildNodes, getAttribute, getAttribute, getAttributes, getChildNodes, getFirstChild, getLastChild, getNextSibling, getNodeName, getNodePath, getNodeValue, getNodeValue, getOwnerOsm, getParentNode, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, removeChild, removeChildNodes, replaceChild, setAttribute, setNodeValue, toString

 

Methods inherited from class java.lang.Object

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

 

Constructor Detail

Properties

public Properties()

Constructs a Properties instance.

---

Properties

public Properties(Properties source)

Constructs a Properties instance from another Properties. Only the references to the objects stored in this Properties are copied, the objects themselves are not copied.

Method Detail

clearProperties

public void clearProperties()

Clears (removes) all properties.

---

removeProperty

public void removeProperty(java.lang.String path)

Removes the specified property and all of its children.

---

propertyExists

public boolean propertyExists(java.lang.String path)

Returns true if the specified property exists.

---

cloneProperties

public Properties cloneProperties()

Returns a duplicate of this Properties. Only the references to the objects stored in this Properties are copied, the objects themselves are not copied.

---

cloneProperties

public void cloneProperties(Properties source)

Duplicates the supplied Properties. Existing values stored in this properties will be overridden. Only the references to the objects stored in this Properties are copied, the objects themselves are not copied.

---

getObject

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

Returns the Object value of the specified property.

---

setObject

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

Sets the Object value of the specified property.

---

getString

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

Returns the String value of the specified property.

---

setString

public void setString(java.lang.String path,
                      java.lang.String value)

Sets the String value of the specified property.

---

getBoolean

public boolean getBoolean(java.lang.String path)

Returns the boolean value of the specified property.

---

setBoolean

public void setBoolean(java.lang.String path,
                       boolean value)

Sets the boolean value of the specified property.

---

getByte

public byte getByte(java.lang.String path)

Returns the byte value of the specified property.

---

setByte

public void setByte(java.lang.String path,
                    byte value)

Sets the byte value of the specified property.

---

getShort

public short getShort(java.lang.String path)

Returns the short value of the specified property.

---

setShort

public void setShort(java.lang.String path,
                     short value)

Sets the short value of the specified property.

---

getInt

public int getInt(java.lang.String path)

Returns the int value of the specified property.

---

setInt

public void setInt(java.lang.String path,
                   int value)

Sets the int value of the specified property.

---

getLong

public long getLong(java.lang.String path)

Returns the long value of the specified property.

---

setLong

public void setLong(java.lang.String path,
                    long value)

Sets the long value of the specified property.

---

getFloat

public float getFloat(java.lang.String path)

Returns the float value of the specified property.

---

setFloat

public void setFloat(java.lang.String path,
                     float value)

Sets the float value of the specified property.

---

getDouble

public double getDouble(java.lang.String path)

Returns the double value of the specified property.

---

setDouble

public void setDouble(java.lang.String path,
                      double value)

Sets the double value of the specified property.

---

getProperties

public java.util.Map getProperties(java.lang.String expression,
                                   boolean includeChildren)

Selects the properties specified by the query expression. A Map of property path/value pairs are returned.

---

getProperties

protected void getProperties(java.util.Collection nodes,
                             boolean includeChildren,
                             java.util.Map result)

Selects the properties specified by the query expression. The selected properties are stored in the supplied Map.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> aendvari >> common >> [ properties overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---