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

Interface Cache

public interface Cache

A Cache let the user store key-value-pairs in a permanent manner and access them. It is possible that a client uses get() before load() therefore the implementation must ensure that no error occurred because of the wrong order. The implementing class should implement a useful toString() method.

Since: Ant 1.6

Version: 2003-09-13

Method Summary
voiddelete()
Deletes the cache.
Objectget(Object key)
Returns a value for a given key from the cache.
booleanisValid()
Checks its prerequisites.
Iteratoriterator()
Returns an iterator over the keys in the cache.
voidload()
Loads the cache, must handle not existing cache.
voidput(Object key, Object value)
Saves a key-value-pair in the cache.
voidsave()
Saves modification of the cache.

Method Detail

delete

public void delete()
Deletes the cache. If file based the file has to be deleted also.

get

public Object get(Object key)
Returns a value for a given key from the cache.

Parameters: key the key

Returns: the stored value

isValid

public boolean isValid()
Checks its prerequisites.

Returns: true if all is ok, otherwise false.

iterator

public Iterator iterator()
Returns an iterator over the keys in the cache.

Returns: An iterator over the keys.

load

public void load()
Loads the cache, must handle not existing cache.

put

public void put(Object key, Object value)
Saves a key-value-pair in the cache.

Parameters: key the key value the value

save

public void save()
Saves modification of the cache.
Copyright B) 2000-2007 Apache Software Foundation. All Rights Reserved.