Top Methods
org.apache.derby.iapi.services.property

public Interface PersistentSet

Known Direct Subinterfaces
org.apache.derby.iapi.store.access.TransactionController
Imports
java.util.Properties, java.io.Serializable, org.apache.derby.shared.common.error.StandardException

Method Summary

Modifier and TypeMethod and Description
public Properties

Returns:

The sub-set of stored properties that can be stored in a java.util.Propertes object.
getProperties
()

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

public Serializable

Returns:

object The requested object or null.
getProperty
(String
The "key" of the property that is being requested.
key
)

Gets a value for a stored property.

public Serializable

Returns:

object The requested object or null.
getPropertyDefault
(String
The "key" of the property that is being requested.
key
)

Gets a default value for a stored property.

public boolean

Returns:

true if the default property is visible
propertyDefaultIsVisible
(String
The "key" of the property that is being requested.
key
)

Return true if the default property is visible.

public void
setProperty(String
The key used to lookup this property.
key
,
Serializable
The value to be associated with this key. If null, delete the property from the properties list.
value
,
boolean
True if property is only ever searched for int the database properties.
dbOnlyProperty
)

Sets the Serializable object associated with a property key.

public void
setPropertyDefault(String
The key used to lookup this propertyDefault.
key
,
Serializable
The default value to be associated with this key. If null, delete the property default from the properties list.
value
)

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

Method Detail

getPropertiesback to summary
public Properties getProperties() throws 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.

Returns:Properties

The sub-set of stored properties that can be stored in a java.util.Propertes object.

Exceptions
StandardException:
Standard exception policy.
getPropertyback to summary
public Serializable getProperty(String key) throws 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.

Parameters
key:String

The "key" of the property that is being requested.

Returns:Serializable

object The requested object or null.

Exceptions
StandardException:
Standard exception policy.
getPropertyDefaultback to summary
public Serializable getPropertyDefault(String key) throws 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.

Parameters
key:String

The "key" of the property that is being requested.

Returns:Serializable

object The requested object or null.

Exceptions
StandardException:
Standard exception policy.
propertyDefaultIsVisibleback to summary
public boolean propertyDefaultIsVisible(String key) throws StandardException

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

Parameters
key:String

The "key" of the property that is being requested.

Returns:boolean

true if the default property is visible

Exceptions
StandardException:
Standard exception policy.
setPropertyback to summary
public void setProperty(String key, Serializable value, boolean dbOnlyProperty) throws 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.

Parameters
key:String

The key used to lookup this property.

value:Serializable

The value to be associated with this key. If null, delete the property from the properties list.

dbOnlyProperty:boolean

True if property is only ever searched for int the database properties.

Exceptions
StandardException:
Standard exception policy.
setPropertyDefaultback to summary
public void setPropertyDefault(String key, Serializable value) throws 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.

Parameters
key:String

The key used to lookup this propertyDefault.

value:Serializable

The default value to be associated with this key. If null, delete the property default from the properties list.

Exceptions
StandardException:
Standard exception policy.