PropertyIO (JHPropertiesTyped

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractFilePropertyIO, AbstractHttpPropertyIO, AbstractJDBCPropertyIO, AbstractPropertyIO, AbstractURLPropertyIO, AbstractXMLFilePropertyIO, AbstractXMLInputStreamPropertyIO, CompositePropertyIO, DatasourceJDBCPropertyIO, FilePropertyIO, HttpCookiesPropertyIO, HttpRequestHeadersPropertyIO, HttpRequestParamsPropertyIO, HttpRequestPropertyIO, HttpResponseHeadersPropertyIO, InputStreamPropertyIO, JBossSystemPropertiesPropertyIO, ManifestPropertyIO, MemoryPropertyIO, ResourceBundlePropertyIO, ResourceFilePropertyIO, ResourceStreamPropertyIO, ServletContextPropertyIO, UrlJDBCPropertyIO, WebContextParamsPropertyIO, XMLParsedFilePropertyIO
```
public interface PropertyIO
extends Serializable
```
The interface for a PropertyIO.
The default implementation used by all other current implementation is in AbstractPropertyIO.

Author:

Frederik Heick

See Also:

AbstractPropertyIO

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`backup()` Returns a string containing all the properties [name=value] in the PropertyIO seperated by a line feed [
`long`	`getCacheTime()` How often the typed value cache for a PropertyIO should be automatically flushed every X milliseconds.
`Date`	`getLastLoaded()` The date for when a property was last loaded not using cache.
`Date`	`getLastSaved()` The date for when a property was last saved.
`org.apache.commons.logging.Log`	`getLogger()` Gets a logger
`String`	`getName()` A short descriptive name of the Property IO.
`Properties`	`getProperties()` Gets all the name,value pair in a Properties class instance.
`String`	`getSource()` A detailed description of the source of the property data.
`<T> Object`	`getTypedValue(String propertyName)` Gets type converted object value from the cache by the property name.
`String`	`getValue(String propertyName)` Gets the string value of the name.
`boolean`	`isCached()` A boolean that determines if the PropertyIO shall cache the name,value pairs and the type converted properties.
`boolean`	`isReadonly()` Determines if the IO is readonly or not.
`void`	`reload()` Reloads the name,value pairs for the PropertyIO, or forces the values to reload when read next time.
`void`	`setCacheTime(long cacheTimeInMs)` Sets the amount of milliseconds between flushing og typed value cache for the PropertyIO.
`void`	`setValue(String propertyName, String value)` Sets the name,value as String in the IO.
`void`	`storeTypedValue(String propertyName, Object value)` Stores a type converted value in the IO cache, if cache option is implemented.
`void`	`validate()` Validates the PropertyIO.

- Method Detail
  - getName
```
String getName()
```
    A short descriptive name of the Property IO.
    
    Returns:
    
    a short descriptive name of the PropertyIO class.
  - getSource
```
String getSource()
```
    A detailed description of the source of the property data.
    
    Returns:
    
    a data source description.
  - getValue
```
String getValue(String propertyName)
```
    Gets the string value of the name.
    Remember to use the cached value, if it shall be used.
    IMPORTANT : When reading a value from a PropertyIO, the value is pre parsed before validation. Remember to call this method in your implementation.
    You can use ${name} in the value, will be passed by the StringUtils.replaceInlinedProperties(String) method, to replace ${name} where name can either be a System.getProperty(String) or System.getenv(String).
    
    Parameters:
    
    propertyName - the name of the property.
    
    Returns:
    
    the value of the property name, if none exists null is returned.
    
    See Also:
    
    StringUtils.replaceInlinedProperties(String), PropertyFrameworkGlobals
  - getTypedValue
```
<T> Object getTypedValue(String propertyName)
```
    Gets type converted object value from the cache by the property name. This is used by the Property class, it will when it has the type converted class store in the IO cache.
    
    Parameters:
    
    propertyName - the name of Property
    
    Returns:
    
    gets the type converted value if stored in cache, otherwise null.
  - storeTypedValue
```
void storeTypedValue(String propertyName,
                     Object value)
```
    Stores a type converted value in the IO cache, if cache option is implemented.
    
    Parameters:
    
    propertyName - the name of the property.
    
    value - the object value to store in cache.
  - isCached
```
boolean isCached()
```
    A boolean that determines if the PropertyIO shall cache the name,value pairs and the type converted properties.
    
    Returns:
    
    true if it shall use cache, otherwise false.
  - isReadonly
```
boolean isReadonly()
```
    Determines if the IO is readonly or not.
    
    Returns:
    
    true if the PropertyIO is readonly, otherwise false.
  - setValue
```
void setValue(String propertyName,
              String value)
       throws PropertyIOException
```
    Sets the name,value as String in the IO. Many IO implementations reloads when a value is set to refresh cache.
    This is recommended, but the framework will update cache items with new values.
    
    Parameters:
    
    propertyName - the name of the property
    
    value - the string value of the property.
    
    Throws:
    
    PropertyIOException - if the IO is readonly or failed to write the value.
  - validate
```
void validate()
       throws PropertyIOException
```
    Validates the PropertyIO.
    
    Throws:
    
    PropertyIOException
  - reload
```
void reload()
```
    Reloads the name,value pairs for the PropertyIO, or forces the values to reload when read next time. Remember to both reset properties and typed value cache if used.
  - getProperties
```
Properties getProperties()
```
    Gets all the name,value pair in a Properties class instance.
    
    Returns:
    
    the Properties available for the IO.
    
    See Also:
    
    Properties
  - getLastLoaded
```
Date getLastLoaded()
```
    The date for when a property was last loaded not using cache.
    
    Returns:
    
    the date when the properties was last loaded set by the get getProperties method, if not loaded new Date(0) shall be returned.
  - getLastSaved
```
Date getLastSaved()
```
    The date for when a property was last saved.
    
    Returns:
    
    the last saved date, if not last saved date is set, new Date(0) is used.
  - getLogger
```
org.apache.commons.logging.Log getLogger()
```
    Gets a logger
    
    Returns:
    
    logger
  - backup
```
String backup()
```
    Returns a string containing all the properties [name=value] in the PropertyIO seperated by a line feed [
```
\n
```
    ].
    Returns:
    
    a back string with all the properties.
  - getCacheTime
```
long getCacheTime()
```
    How often the typed value cache for a PropertyIO should be automatically flushed every X milliseconds.
    
    Returns:
    
    the amount of milliseconds between the typed value cache is flushed. If less than or equal to zero no automatic cache flush is performed and must be done manually with reload.
    
    See Also:
    
    reload()
  - setCacheTime
```
void setCacheTime(long cacheTimeInMs)
```
    Sets the amount of milliseconds between flushing og typed value cache for the PropertyIO.
    This will override the global framework paramenter for default property io flushing.
    
    Parameters:
    
    cacheTimeInMs - the amount of milliseconds between the typed value cache is flushed. if less than or equal to zero no automatic cache flush is performed and must be done manually with reload.

Interface PropertyIO

Method Summary

Method Detail

getName

getSource

getValue

getTypedValue

storeTypedValue

isCached

isReadonly

setValue

validate

reload

getProperties

getLastLoaded

getLastSaved

getLogger

backup

getCacheTime

setCacheTime