CacheEngine


1   /*
2    * Copyright (c) Rafael Steil
3    * All rights reserved.
4    * 
5    * Redistribution and use in source and binary forms, 
6    * with or without modification, are permitted provided 
7    * that the following conditions are met:
8    * 
9    * 1) Redistributions of source code must retain the above 
10   * copyright notice, this list of conditions and the 
11   * following  disclaimer.
12   * 2)  Redistributions in binary form must reproduce the 
13   * above copyright notice, this list of conditions and 
14   * the following disclaimer in the documentation and/or 
15   * other materials provided with the distribution.
16   * 3) Neither the name of "Rafael Steil" nor 
17   * the names of its contributors may be used to endorse 
18   * or promote products derived from this software without 
19   * specific prior written permission.
20   * 
21   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT 
22   * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
23   * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, 
24   * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
25   * MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
26   * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 
27   * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE 
28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
29   * EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
30   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
31   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 
32   * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
33   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 
34   * IN CONTRACT, STRICT LIABILITY, OR TORT 
35   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
36   * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
37   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
38   * 
39   * Created on Jan 13, 2005 5:58:36 PM
40   * The JForum Project
41   * http://www.jforum.net
42   */
43  package net.jforum.cache;
44  
45  import java.util.Collection  ;
46  
47  /**
48   * @author Rafael Steil
49   * @version $Id: CacheEngine.java,v 1.9 2005/09/25 02:40:28 rafaelsteil Exp $
50   */
51  public interface CacheEngine
52  {
53      public static final String   DUMMY_FQN = "";
54      public static final String   NOTIFICATION = "notification";
55      
56      /**
57       * Inits the cache engine. 
58       */
59      public void init();
60      
61      /**
62       * Stops the cache engine
63       */
64      public void stop();
65      
66      /**
67       * Adds a new object to the cache. 
68       * The fqn will be set as the value of {@link #DUMMY_FQN}
69       * 
70       * @param key The key to associate with the object. 
71       * @param value The object to cache
72       */
73      public void add(String   key, Object   value);
74      
75      /**
76       * 
77       * Adds a new object to the cache.
78       * 
79       * @param fqn The fully qualified name of the cache. 
80       * @param key The key to associate with the object
81       * @param value The object to cache
82       */
83      public void add(String   fqn, String   key, Object   value);
84      
85      /**
86       * Gets some object from the cache.
87       * 
88       * @param fqn The fully qualified name associated with the key
89       * @param key The key to get
90       * @return The cached object, or <code>null</code> if no entry was found
91       */
92      public Object   get(String   fqn, String   key);
93      
94      /**
95       * Gets some object from the cache.
96       * 
97       * @param key The fqn tree to get
98       * @return The cached object, or <code>null</code> if no entry was found
99       */
100     public Object   get(String   fqn);
101     
102     /**
103      * Gets all values from some given FQN.
104      * 
105      * @param fqn
106      * @return
107      */
108     public Collection   getValues(String   fqn);
109     
110     /**
111      * Removes an entry from the cache.
112      * 
113      * @param fqn The fully qualified name associated with the key
114      * @param key The key to remove
115      */
116     public void remove(String   fqn, String   key);
117     
118     /**
119      * Removes a complete note from the cache
120      * @param key The fqn to remove
121      */
122     public void remove(String   fqn);
123 }
124
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags