de.smartics.properties.spi.config.support
Interface ConfigurationPropertiesSpi

All Superinterfaces:

ConfigurationProperties

All Known Subinterfaces:

ConfigurationPropertiesManagementSpi, SerializableConfigurationPropertiesManagementSpi

All Known Implementing Classes:

AbstractAdminModeConfigurationProperties, AbstractConfigurationProperties, AbstractConfigurationPropertiesManagement, AbstractExternalConfigurationPropertiesManagement, AbstractInMemoryConfigurationProperties, BootConfigurationProperties, ClasspathConfigurationProperties, ConfigurationPropertiesManagementWithDefaults, DataSourceConfigurationProperties, JndiConfigurationProperties, PropertiesConfigurationProperties, SerializableCacheConfigurationPropertiesManagement

public interface ConfigurationPropertiesSpi
     
     

      
      extends 
      
      ConfigurationProperties
     
     

Provides an extended interface to service providers.

Method Summary

<T> T

getProperties(Class<T> propertiesInterface, SerializableConfigurationProperties configuration) Returns a implementation of the given interface that has access to the property keys, the property descriptors and the properties itself, when they are declared in the given interface.

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

addPropertyChangeListener, addPropertyChangeListener, getContext, getContext, getKey, getProperties, getProperty, getProperty, getProperty, getProperty, getProperty, getPropertyAsType, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValueAsString, getPropertyValueAsString, getPropertyValueAsString, getPropertyValueAsString, getValidatedProperty, getValidatedProperty, getValidatedProperty, isInAdminMode, removePropertyChangeListener, removePropertyChangeListener, toRepresentative, toSerializable, validate, validate, validate, validate, validate

Method Detail

getProperties

<T> T getProperties(Class<T> propertiesInterface,
                    SerializableConfigurationProperties configuration)

Returns a implementation of the given interface that has access to the property keys, the property descriptors and the properties itself, when they are declared in the given interface. The interface must be annotated with an PropertySet annotation.

Allows to pass in a configuration to consult.

Type Parameters:

T - type variable to enable a type save return value.

Parameters:

propertiesInterface - a PropertySet annotated interface for which a implementation to access the property keys, descriptors and values is requested.

configuration - the access to the properties. Must not be null.

Returns:

a implementation of the given interface to access property information.