Class PropertiesfileCache
java.lang.Object
org.apache.tools.ant.types.selectors.modifiedselector.PropertiesfileCache
- All Implemented Interfaces:
Cache
public class PropertiesfileCache extends java.lang.Object implements Cache
Use java.util.Properties for storing the values.
The use of this Cache-implementation requires the use of the parameter
<param name="cache.cachefile" .../> for defining, where to store the
properties file.
The ModifiedSelector sets the cachefile to the default value
cache.properties.
Supported <param>s are:
name | values | description | required |
---|---|---|---|
cache.cachefile | path to file | the name of the properties file | yes |
- Since:
- Ant 1.6
- Version:
- 2003-09-13
-
Constructor Summary
Constructors Constructor Description PropertiesfileCache()
Bean-Constructor.PropertiesfileCache(java.io.File cachefile)
Constructor. -
Method Summary
Modifier and Type Method Description void
delete()
Deletes the cache and its underlying file.java.lang.Object
get(java.lang.Object key)
Returns a value for a given key from the cache.java.io.File
getCachefile()
Getter.boolean
isValid()
This cache is valid if the cachefile is set.java.util.Iterator<java.lang.String>
iterator()
Returns an iterator over the keys in the cache.void
load()
Load the cache from underlying properties file.void
put(java.lang.Object key, java.lang.Object value)
Saves a key-value-pair in the cache.void
save()
Saves modification of the cache.void
setCachefile(java.io.File file)
Setter.java.lang.String
toString()
Override Object.toString().
-
Constructor Details
-
PropertiesfileCache
public PropertiesfileCache()Bean-Constructor. -
PropertiesfileCache
public PropertiesfileCache(java.io.File cachefile)Constructor.- Parameters:
cachefile
- set the cachefile
-
-
Method Details
-
setCachefile
public void setCachefile(java.io.File file)Setter.- Parameters:
file
- new value
-
getCachefile
public java.io.File getCachefile()Getter.- Returns:
- the cachefile
-
isValid
public boolean isValid()This cache is valid if the cachefile is set. -
load
public void load()Load the cache from underlying properties file. -
save
public void save()Saves modification of the cache. Cache is only saved if there is one ore more entries. Because entries can not be deleted by this API, this Cache implementation checks the existence of entries before creating the file for performance optimisation. -
delete
public void delete()Deletes the cache and its underlying file. -
get
public java.lang.Object get(java.lang.Object key)Returns a value for a given key from the cache. -
put
public void put(java.lang.Object key, java.lang.Object value)Saves a key-value-pair in the cache. -
iterator
public java.util.Iterator<java.lang.String> iterator()Returns an iterator over the keys in the cache. -
toString
public java.lang.String toString()Override Object.toString().- Overrides:
toString
in classjava.lang.Object
- Returns:
- information about this cache
-