icachecontroller.java

一个很好的开源项目管理系统源代码

/*

 */
package net.java.workeffort.infrastructure.cache;

/**
 * The cache controller interface used by the application for caching.
 * @author Antony Joseph
 */
public interface ICacheController {
    /**
     * @param key The key
     * @return The object
     */
    Object getObject(String key) throws RefreshRequiredException;

    /**
     * @param key The key
     * @return The object
     */
    Object removeObject(String key);

    /**
     * @param key The key
     * @param object The object
     */
    void putObject(String key, Object object);

    /**
     * Put object in cache and tie it to the groups
     * @param key The key
     * @param object The object
     * @param groups The groups the object is tied to
     */
    void putObject(String key, Object object, String[] groups);

    /**
     * Flush all entries belonging to a group.
     * @param group The group
     */
    void flushGroup(String group);

    /**
     * This should only be called by a thread that received a
     * RefreshRequiredException and was unable to generate some new cache
     * content.
     * @param key The cache entry key
     */
    void cancelUpdate(String key);

    /**
     * Destroys the cache.
     */
    void destroy();

}