View Javadoc

1   /*
2    * Copyright 2001-2004 The Apache Software Foundation
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.apache.commons.cache;
17  
18  import java.io.Serializable;
19  
20  /**
21   * tk.
22   * @version $Id: Stash.java 155435 2005-02-26 13:17:27Z dirkv $
23   * @author Rodney Waldhoff
24   */
25  public interface Stash extends Serializable {
26    public static final int YES             = 1;
27    public static final int NO_FULL         = 2;
28    public static final int NO_NOT_STORABLE = 3;
29    public static final int NO              = 4;
30  
31    public int canStore(Serializable key, Serializable val, Long expiresAt, Long cost, Serializable group);
32    public int canStore(Serializable key, Serializable val, Long expiresAt, Long cost, Serializable group, byte[] serialized);
33    public boolean store(Serializable key, Serializable val, Long expiresAt, Long cost, Serializable group);
34    public boolean store(Serializable key, Serializable val, Long expiresAt, Long cost, Serializable group, byte[] serialized);
35    public Serializable retrieve(Serializable key);
36    public boolean contains(Serializable key);
37    public void clear(Serializable key);
38    public void clear();
39    public float capacity();
40  
41  
42    public void setCache(Cache c);
43    public void unsetCache();
44    public boolean wantsSerializedForm();
45  }