de.smartics.properties.api.config.domain
Interface PropertyStoreAccessor

All Superinterfaces:

Serializable

public interface PropertyStoreAccessor
     
     

      
      extends 
      
      Serializable
     
     

Provides direct access to the properties of a configuration.

Note:

Note that changes made to the store via this interface are not reflected in the already loaded configurations, because they cache values and do not get informed of changes. Clients should usually only use reading methods of this interface.

Method Summary

Property	deletePropertyInStore(String name) Deletes the property with the given name.
PropertyCollection	getPropertyCollectionFromStore() Returns a collection to iterate over all properties of the configuration.
Property	getPropertyFromStore(String name) Fetches the property from the store by the given name.
Property	setPropertyToStore(String name, String value) Sets the property to the given value.

Method Detail

setPropertyToStore

Property setPropertyToStore(String name,
                            String value)
                            throws NullPointerException,
                                   PropertyStoreException

Sets the property to the given value.

Implementation Notes:

No property change listeners are informed here. This is solely the call to the underlying store.

Parameters:

name - the name of the property to set.

value - the value to the property.

Returns:

the old property. Must not be null (although the value of the property may be null).

Throws:

NullPointerException - if name is null.

PropertyStoreException - on any problem accessing the store.

getPropertyCollectionFromStore

PropertyCollection getPropertyCollectionFromStore()
                                                  throws PropertyStoreException

Returns a collection to iterate over all properties of the configuration.

Implementation Notes:

No property change listeners are informed here. This is solely the call to the underlying store.

Returns:

a collection to iterate over all properties of the configuration.

Throws:

PropertyStoreException - on any problem accessing the store.

deletePropertyInStore

Property deletePropertyInStore(String name)
                               throws PropertyStoreException

Deletes the property with the given name.

Implementation Notes:

No property change listeners are informed here. This is solely the call to the underlying store.

Parameters:

name - the name of the property to delete.

Returns:

the value of the deleted property.

Throws:

PropertyStoreException - on any problem accessing the store.

getPropertyFromStore

Property getPropertyFromStore(String name)
                              throws PropertyStoreException

Fetches the property from the store by the given name.

Implementation Notes:

No property change listeners are informed here. This is solely the call to the underlying store.

Parameters:

name - the name of the property to fetch.

Returns:

the property value. Must not be null (although the value of the property may be null).

Throws:

PropertyStoreException - on any problem accessing the store.