org.apache.tools.ant.types.selectors.modifiedselector

Class PropertiesfileCache

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 for defining, where to store the properties file. The ModifiedSelector sets the cachefile to the default value cache.properties. Supported s are:
namevaluesdescriptionrequired
cache.cachefile path to file the name of the properties file yes

Version:
2003-09-13

Since:
Ant 1.6

Constructor Summary

PropertiesfileCache()
Bean-Constructor.
PropertiesfileCache(File cachefile)
Constructor.

Method Summary

void
delete()
Deletes the cache and its underlying file.
Object
get(Object key)
Returns a value for a given key from the cache.
File
getCachefile()
boolean
isValid()
Checks its prerequisites.
Iterator
iterator()
Returns an iterator over the keys in the cache.
void
load()
Loads the cache, must handle not existing cache.
void
put(Object key, Object value)
Saves a key-value-pair in the cache.
void
save()
Saves modification of the cache.
void
setCachefile(File file)
String
toString()
Override Object.toString().

Constructor Details

PropertiesfileCache

public PropertiesfileCache()
Bean-Constructor.


PropertiesfileCache

public PropertiesfileCache(File cachefile)
Constructor.

Parameters:
cachefile - set the cachefile

Method Details

delete

public void delete()
Deletes the cache and its underlying file.
Specified by:
delete in interface Cache


get

public Object get(Object key)
Returns a value for a given key from the cache.
Specified by:
get in interface Cache

Parameters:
key - the key

Returns:
the stored value


getCachefile

public File getCachefile()


isValid

public boolean isValid()
Checks its prerequisites.
Specified by:
isValid in interface Cache

Returns:
true if all is ok, otherwise false.


iterator

public Iterator iterator()
Returns an iterator over the keys in the cache.
Specified by:
iterator in interface Cache

Returns:
An iterator over the keys.


load

public void load()
Loads the cache, must handle not existing cache.
Specified by:
load in interface Cache


put

public void put(Object key,
                Object value)
Saves a key-value-pair in the cache.
Specified by:
put in interface Cache

Parameters:
key - the key
value - the value


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.
Specified by:
save in interface Cache


setCachefile

public void setCachefile(File file)


toString

public String toString()
Override Object.toString().

Returns:
information about this cache


Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.