|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
java.io.Serializable getProperty(java.lang.String key) throws StandardException
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.
key
- The "key" of the property that is being requested.
StandardException
- Standard exception policy.java.io.Serializable getPropertyDefault(java.lang.String key) throws StandardException
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.
key
- The "key" of the property that is being requested.
StandardException
- Standard exception policy.boolean propertyDefaultIsVisible(java.lang.String key) throws StandardException
key
- The "key" of the property that is being requested.
StandardException
- Standard exception policy.void setProperty(java.lang.String key, java.io.Serializable value, boolean dbOnlyProperty) throws StandardException
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.
key
- The key used to lookup this property.value
- The value to be associated with this key. If null,
delete the property from the properties list.dbOnlyProperty
- True if property is only ever searched for int the database properties.
StandardException
- Standard exception policy.void setPropertyDefault(java.lang.String key, java.io.Serializable value) throws StandardException
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.
key
- The key used to lookup this propertyDefault.value
- The default value to be associated with this key.
If null, delete the property default from the
properties list.
StandardException
- Standard exception policy.java.util.Properties getProperties() throws StandardException
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.
StandardException
- Standard exception policy.
|
Built on Thu 2010-12-23 20:49:13+0000, from revision ??? | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |