de.smartics.properties.impl.config.classpath
Class ClasspathConfigurationProperties

java.lang.Object
  de.smartics.properties.spi.config.support.AbstractConfigurationProperties
      de.smartics.properties.spi.config.support.AbstractConfigurationPropertiesManagement
          de.smartics.properties.spi.config.support.AbstractInMemoryConfigurationProperties
              de.smartics.properties.impl.config.classpath.ClasspathConfigurationProperties

All Implemented Interfaces:

ConfigurationProperties, ConfigurationPropertiesManagement, SerializableConfigurationProperties, SerializableConfigurationPropertiesManagement, ConfigurationPropertiesManagementSpi, ConfigurationPropertiesSpi, Serializable

@ThreadSafe
public final class ClasspathConfigurationProperties
     
     

      
      extends 
      
      AbstractInMemoryConfigurationProperties
     
     

Implementation based on Properties.

This implementation is not capable of tracking changes to properties after they have been added to this configuration.

See Also:

Serialized Form

Constructor Summary

ClasspathConfigurationProperties()
Convenience constructor using its own registry and an artificial key.

ClasspathConfigurationProperties(boolean requiresDefaultOnClassPath)
Convenience constructor allowing to control the need of existing properties files on the classpath, using its own registry and an artificial key.

ClasspathConfigurationProperties(ConfigurationKey key)
Convenience constructor using its own registry.

ClasspathConfigurationProperties(ConfigurationKey key, PropertyDescriptorRegistry registry)
Default constructor.

Method Summary

SerializableConfigurationPropertiesManagement

toSerializable() Creates a serializable variant of this implementation.

Methods inherited from class de.smartics.properties.spi.config.support.AbstractInMemoryConfigurationProperties

addClassPathProperties, deletePropertyInStore, getPropertyCollectionFromStore, getPropertyFromStore, setPropertyToStore, toString

Methods inherited from class de.smartics.properties.spi.config.support.AbstractConfigurationPropertiesManagement

addDefinitions, addDescriptors, flush, getDescriptor, getDescriptor, getMandatoryPropertyDescriptors, getProperty, getProperty, getResolvedProperty, setProperty, unsetProperty, validate

Methods inherited from class de.smartics.properties.spi.config.support.AbstractConfigurationProperties

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, getContext, getContext, getKey, getProperties, getProperties, getProperty, getProperty, getProperty, getPropertyDescriptor, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValueAsString, getPropertyValueAsString, getPropertyValueAsString, getPropertyValueAsString, getRegistry, getResolvedProperty, getResolvedProperty, removePropertyChangeListener, removePropertyChangeListener, resolveAndConvert, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.smartics.properties.api.config.domain.ConfigurationPropertiesManagement

addDefinitions, addDescriptors, flush, getDescriptor, getDescriptor, getMandatoryPropertyDescriptors, getRegistry, setProperty, unsetProperty

Methods inherited from interface de.smartics.properties.api.config.domain.ConfigurationProperties

addPropertyChangeListener, addPropertyChangeListener, getContext, getContext, getKey, getProperties, getProperty, getProperty, getProperty, getProperty, getProperty, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValueAsString, getPropertyValueAsString, getPropertyValueAsString, getPropertyValueAsString, getResolvedProperty, getResolvedProperty, getResolvedProperty, removePropertyChangeListener, removePropertyChangeListener, validate, validate

Methods inherited from interface de.smartics.properties.spi.config.support.ConfigurationPropertiesSpi

getProperties

Constructor Detail

ClasspathConfigurationProperties

public ClasspathConfigurationProperties()

Convenience constructor using its own registry and an artificial key.

ClasspathConfigurationProperties

public ClasspathConfigurationProperties(boolean requiresDefaultOnClassPath)

Convenience constructor allowing to control the need of existing properties files on the classpath, using its own registry and an artificial key.

Parameters:

requiresDefaultOnClassPath - the flag controls the behavior on not finding default properties on the classpath. If the value is true not finding the properties file on the class path signals an exception, if set to false the properties are not required to exist. In the latter case the properties may be set purely programatically.

ClasspathConfigurationProperties

public ClasspathConfigurationProperties(ConfigurationKey key)
                                 throws de.smartics.util.lang.NullArgumentException

Convenience constructor using its own registry.

Parameters:

key - the key that identifies the configuration.

Throws:

de.smartics.util.lang.NullArgumentException - if key is null.

ClasspathConfigurationProperties

public ClasspathConfigurationProperties(ConfigurationKey key,
                                        PropertyDescriptorRegistry registry)
                                 throws de.smartics.util.lang.NullArgumentException

Default constructor.

Parameters:

key - the key that identifies the configuration.

registry - the registry to resolve property descriptors.

Throws:

de.smartics.util.lang.NullArgumentException - if key or registry is null.

Method Detail

toSerializable

public SerializableConfigurationPropertiesManagement toSerializable()

Description copied from interface: ConfigurationProperties

Creates a serializable variant of this implementation.

Returns:

a serializable variant of this implementation.

See Also:

ConfigurationPropertiesProxy, ConfigurationPropertiesManagementProxy