AbstractPropertyIO (JHPropertiesTyped

java.lang.Object
- dk.heick.properties.io.AbstractPropertyIO

All Implemented Interfaces:

PropertyIO, Serializable

Direct Known Subclasses:

AbstractFilePropertyIO, AbstractHttpPropertyIO, AbstractJDBCPropertyIO, AbstractURLPropertyIO, AbstractXMLInputStreamPropertyIO, CompositePropertyIO, InputStreamPropertyIO, ManifestPropertyIO, MemoryPropertyIO, ResourceBundlePropertyIO, ResourceFilePropertyIO, ResourceStreamPropertyIO, ServletContextPropertyIO, WebContextParamsPropertyIO
```
public abstract class AbstractPropertyIO
extends Object
implements PropertyIO
```
An implementation of PropertyIO that handles caching of typed objects and the read only property.

Since:

1.0

Author:

Frederik Heick

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AbstractPropertyIO(boolean readonly, boolean cached)
Returns an instance of the class with readonly and cache property.

Constructors
Constructor and Description
`AbstractPropertyIO(boolean readonly, boolean cached)` Returns an instance of the class with readonly and cache property.

Method Summary

All Methods Instance Methods Concrete 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
`Properties`	`getTypedProperties()` Gets `Properties` with the content `name` and `object`.
`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.
`protected void`	`logPerformanceGetProperties(long startTime)` Convenience method - Call this method as the last in "getProperties" (in the finally section), this will than handle a standardized performance logging and message.
`protected void`	`logPerformanceSetValue(String propertyName, long startTime)` Convenience method - Call this method as the last in "setValue" (in the finally section), this will than handle a standardized performance logging and message.
`void`	`reload()` Reloads the name,value pairs for the PropertyIO, or forces the values to reload when read next time.
`void`	`setCacheTime(long cacheTime)` How often the typed value cache for a PropertyIO should be automatically flushed every X milliseconds. This will override the global framework paramenter for default property io flushing.
`void`	`storeTypedValue(String propertyName, Object value)` Stores a type converted value in the IO cache, if cache option is implemented.
`protected void`	`updateLastLoaded()` Sets the date on when the properties was last loaded to current date.
`protected void`	`updateLastSaved()` Sets the date on when the properties was last saved to current date.
`protected void`	`validateWritable(String propertyName)` Convenience method that verifies that the PropertyIO is writeable otherwise a PropertyIOException is thrown with a standardized message.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dk.heick.properties.PropertyIO
getName, getProperties, getSource, setValue, validate

- Constructor Detail
  - AbstractPropertyIO
```
public AbstractPropertyIO(boolean readonly,
                          boolean cached)
```
    Returns an instance of the class with readonly and cache property.
    
    Parameters:
    
    readonly - shall the AbstractPropertyIO be read only.
    
    cached - shall the values be cached in the PropertyIO's.
- Method Detail
  - getTypedValue
```
public final Object getTypedValue(String propertyName)
```
    Description copied from interface: PropertyIO
    
    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.
    
    Specified by:
    
    getTypedValue in interface PropertyIO
    
    Parameters:
    
    propertyName - the name of Property
    
    Returns:
    
    gets the type converted value if stored in cache, otherwise null.
  - storeTypedValue
```
public final void storeTypedValue(String propertyName,
                                  Object value)
```
    Description copied from interface: PropertyIO
    
    Stores a type converted value in the IO cache, if cache option is implemented.
    
    Specified by:
    
    storeTypedValue in interface PropertyIO
    
    Parameters:
    
    propertyName - the name of the property.
    
    value - the object value to store in cache.
  - getCacheTime
```
public long getCacheTime()
```
    How often the typed value cache for a PropertyIO should be automatically flushed every X milliseconds.
    
    Specified by:
    
    getCacheTime in interface PropertyIO
    
    Returns:
    
    the cacheTime for typed cached value in milliseconds. If less than or equal to zero no automatic cache flush is performed and must be done manually with reload.
    
    See Also:
    
    PropertyIO.reload()
  - setCacheTime
```
public final void setCacheTime(long cacheTime)
```
    How often the typed value cache for a PropertyIO should be automatically flushed every X milliseconds.
    This will override the global framework paramenter for default property io flushing.
    
    Specified by:
    
    setCacheTime in interface PropertyIO
    
    Parameters:
    
    cacheTime - 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()
  - getTypedProperties
```
public final Properties getTypedProperties()
```
    Gets Properties with the content name and object.
    
    Returns:
    
    properties
  - isCached
```
public final boolean isCached()
```
    Description copied from interface: PropertyIO
    
    A boolean that determines if the PropertyIO shall cache the name,value pairs and the type converted properties.
    
    Specified by:
    
    isCached in interface PropertyIO
    
    Returns:
    
    true if it shall use cache, otherwise false.
  - isReadonly
```
public final boolean isReadonly()
```
    Description copied from interface: PropertyIO
    
    Determines if the IO is readonly or not.
    
    Specified by:
    
    isReadonly in interface PropertyIO
    
    Returns:
    
    true if the PropertyIO is readonly, otherwise false.
  - reload
```
public void reload()
```
    Description copied from interface: PropertyIO
    
    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.
    
    Specified by:
    
    reload in interface PropertyIO
  - getValue
```
public String getValue(String propertyName)
```
    Description copied from interface: PropertyIO
    
    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).
    
    Specified by:
    
    getValue in interface PropertyIO
    
    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
  - backup
```
public String backup()
```
    Description copied from interface: PropertyIO
    Returns a string containing all the properties [name=value] in the PropertyIO seperated by a line feed [
```
\n
```
    ].
    Specified by:
    
    backup in interface PropertyIO
    
    Returns:
    
    a back string with all the properties.
  - getLastLoaded
```
public final Date getLastLoaded()
```
    Description copied from interface: PropertyIO
    
    The date for when a property was last loaded not using cache.
    
    Specified by:
    
    getLastLoaded in interface PropertyIO
    
    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
```
public final Date getLastSaved()
```
    Description copied from interface: PropertyIO
    
    The date for when a property was last saved.
    
    Specified by:
    
    getLastSaved in interface PropertyIO
    
    Returns:
    
    the last saved date, if not last saved date is set, new Date(0) is used.
  - updateLastLoaded
```
protected final void updateLastLoaded()
```
    Sets the date on when the properties was last loaded to current date. "new Date()".
  - updateLastSaved
```
protected final void updateLastSaved()
```
    Sets the date on when the properties was last saved to current date. "new Date()".
  - getLogger
```
public org.apache.commons.logging.Log getLogger()
```
    Description copied from interface: PropertyIO
    
    Gets a logger
    
    Specified by:
    
    getLogger in interface PropertyIO
    
    Returns:
    
    logger
  - logPerformanceGetProperties
```
protected final void logPerformanceGetProperties(long startTime)
```
    Convenience method - Call this method as the last in "getProperties" (in the finally section), this will than handle a standardized performance logging and message.
    
    Parameters:
    
    startTime - the System.currentTimeMillis() when the method started.
    
    See Also:
    
    System.currentTimeMillis(), PropertyIO.getProperties()
  - logPerformanceSetValue
```
protected final void logPerformanceSetValue(String propertyName,
                                            long startTime)
```
    Convenience method - Call this method as the last in "setValue" (in the finally section), this will than handle a standardized performance logging and message.
    
    Parameters:
    
    propertyName - the name of the property you are trying to set.
    
    startTime - the System.currentTimeMillis() when the method started.
  - validateWritable
```
protected final void validateWritable(String propertyName)
                               throws PropertyIOException
```
    Convenience method that verifies that the PropertyIO is writeable otherwise a PropertyIOException is thrown with a standardized message.
    Call this as the first method call in "setValue".
    
    Parameters:
    
    propertyName - the name of the property use are trying to set.
    
    Throws:
    
    PropertyIOException - the exception thrown if the PropertyIO is not writeable,
    
    See Also:
    
    isReadonly(), PropertyIO.setValue(String, String)

Class AbstractPropertyIO

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface dk.heick.properties.PropertyIO

Constructor Detail

AbstractPropertyIO

Method Detail

getTypedValue

storeTypedValue

getCacheTime

setCacheTime

getTypedProperties

isCached

isReadonly

reload

getValue

backup

getLastLoaded

getLastSaved

updateLastLoaded

updateLastSaved

getLogger

logPerformanceGetProperties

logPerformanceSetValue

validateWritable