View Javadoc

1   /*   Open Source Java Caching Service
2   *    Copyright (C) 2002 Frank Karlstrøm
3   *    This library is free software; you can redistribute it and/or
4   *    modify it under the terms of the GNU Lesser General Public
5   *    License as published by the Free Software Foundation; either
6   *    version 2.1 of the License, or (at your option) any later version.
7   *
8   *    This library is distributed in the hope that it will be useful,
9   *    but WITHOUT ANY WARRANTY; without even the implied warranty of
10  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11  *    Lesser General Public License for more details.
12  *
13  *    You should have received a copy of the GNU Lesser General Public
14  *    License along with this library; if not, write to the Free Software
15  *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16  *
17  *    The author can be contacted by email: fjankk@users.sourceforge.net
18  */
19  package javax.util.jcache;
20  
21  /**
22   * Interface describing various events that can happen as elements are added to or removed from a cache 
23   * @author Frank Karlstrøm
24   *
25   */
26  public interface CacheListener extends CacheEventListener {
27      
28      public void onClear();
29      /**
30       * Triggered when a cache mapping is removed due to eviction 
31       * @param key the object wich is evicted.
32       */
33      public void onEvict(Object key);
34      /**
35       * Triggered when a cache mapping is created due to the cache loader being consulted 
36       * @param key the object wich is loaded.
37       */
38      public void onLoad(Object key);
39      /**
40       * Triggered when a cache mapping is created due to calling Cache.put() 
41       * @param key the object wich is put.
42       */
43      public void onPut(Object key);
44      /**
45       * Triggered when a cache mapping is removed due to calling Cache.remove() 
46       * @param key the object wich is removed.
47       */
48      public void onRemove(Object key);
49  }
50