Cache


1   /*
2    * CoadunationLib: The coaduntion implementation library.
3    * Copyright (C) 2006  Rift IT Contracting
4    * 
5    * This library is free software; you can redistribute it and/or
6    * modify it under the terms of the GNU Lesser General Public
7    * License as published by the Free Software Foundation; either
8    * version 2.1 of the License, or (at your option) any later version.
9    * 
10   * This library is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13   * Lesser General Public License for more details.
14   * 
15   * You should have received a copy of the GNU Lesser General Public
16   * License along with this library; if not, write to the Free Software
17   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
18   *
19   * Cache.java
20   *
21   * The cache interface supplies a standard set of cache maintainance methods. It
22   * does not enable a user to access the cache entries directly.
23   */
24  
25  package com.rift.coad.lib.cache;
26  
27  /**
28   * The cache interface supplies a standard set of cache maintainance methods. It
29   * does not enable a user to access the cache entries directly.
30   *
31   * @author Brett Chaldecott
32   */
33  public interface Cache {
34      /**
35       * This method is called to perform garbage collection on the cache entries.
36       */
37      public void garbageCollect();
38      
39      
40      /**
41       * This method is called to forcibly remove everything from the cache.
42       */
43      public void clear();
44      
45      
46      /**
47       * This mehtod returns true if the cache contains the checked entry.
48       *
49       * @return TRUE if the cache contains the checked entry.
50       * @param cacheEntry The entry to perform the check for.
51       */
52      public boolean contains(Object   cacheEntry);
53  }
54
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags