Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> derby >> iapi >> services >> [ property overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.derby.iapi.services.property
Interface PersistentSet  

---

public interface PersistentSet

---

Method Summary
java.util.Properties	getProperties()           Get properties that can be stored in a java.util.Properties object.
java.io.Serializable	getProperty(java.lang.String key)           Gets a value for a stored property.
java.io.Serializable	getPropertyDefault(java.lang.String key)           Gets a default value for a stored property.
boolean	propertyDefaultIsVisible(java.lang.String key)           Return true if the default property is visible.
void	setProperty(java.lang.String key, java.io.Serializable value, boolean dbOnlyProperty)           Sets the Serializable object associated with a property key.
void	setPropertyDefault(java.lang.String key, java.io.Serializable value)           Sets the Serializable object default value associated with a property key.

 

Method Detail

getProperty

public java.io.Serializable getProperty(java.lang.String key)
                                 throws org.apache.derby.iapi.error.StandardException

Gets a value for a stored property. The returned value will be:

1. the de-serialized object associated with the key using setProperty if such a value is defined or
2. the default de-serialized object associated with the key using setPropertyDefault if such a value is defined or
3. null

The Store provides a transaction protected list of database properties. Higher levels of the system can store and retrieve these properties once Recovery has finished. Each property is a serializable object and is stored/retrieved using a String key.

---

getPropertyDefault

public java.io.Serializable getPropertyDefault(java.lang.String key)
                                        throws org.apache.derby.iapi.error.StandardException

Gets a default value for a stored property. The returned value will be:

1. the default de-serialized object associated with the key using setPropertyDefault if such a value is defined or
2. null

The Store provides a transaction protected list of database properties. Higher levels of the system can store and retrieve these properties once Recovery has finished. Each property is a serializable object and is stored/retrieved using a String key.

---

propertyDefaultIsVisible

public boolean propertyDefaultIsVisible(java.lang.String key)
                                 throws org.apache.derby.iapi.error.StandardException

Return true if the default property is visible. A default is visible as long as the property is not set.

---

setProperty

public void setProperty(java.lang.String key,
                        java.io.Serializable value,
                        boolean dbOnlyProperty)
                 throws org.apache.derby.iapi.error.StandardException

Sets the Serializable object associated with a property key.

See the discussion of getProperty().

The value stored may be a Formatable object or a Serializable object whose class name starts with java.*. This stops arbitary objects being stored in the database by class name, which will cause problems in obfuscated/non-obfuscated systems.

---

setPropertyDefault

public void setPropertyDefault(java.lang.String key,
                               java.io.Serializable value)
                        throws org.apache.derby.iapi.error.StandardException

Sets the Serializable object default value associated with a property key.

See the discussion of getProperty().

The value stored may be a Formatable object or a Serializable object whose class name starts with java.*. This stops arbitary objects being stored in the database by class name, which will cause problems in obfuscated/non-obfuscated systems.

---

getProperties

public java.util.Properties getProperties()
                                   throws org.apache.derby.iapi.error.StandardException

Get properties that can be stored in a java.util.Properties object.

Get the sub-set of stored properties that can be stored in a java.util.Properties object. That is all the properties that have a value of type java.lang.String. Changes to this properties object are not reflected in any persisent storage.

Code must use the setProperty() method call.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> derby >> iapi >> services >> [ property overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---