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   * An abstract base implementation of {@link StashPolicy},
22   * declaring the non-serialized version of
23   * {@link #shouldStore <tt>shouldStore</tt>} to invoke the
24   * serialized one, and {@link #wantsSerializedForm <tt>wantsSerializedForm</tt>} to
25   * return <tt>false</tt>.
26   *
27   * @version $Id: BaseStashPolicy.java 155435 2005-02-26 13:17:27Z dirkv $
28   * @author Rodney Waldhoff
29   */
30  public abstract class BaseStashPolicy implements StashPolicy {
31    public abstract boolean shouldStore(Serializable key, Serializable val, Long expiresAt, Long cost, byte[] serialized);
32    public abstract void setCache(Cache c);
33    public abstract void unsetCache();
34  
35    /** Equivalent to {@link #shouldStore(java.io.Serializable,java.io.Serializable,java.lang.Long,java.lang.Long,byte[]) <tt>canStore(<i>key</i>,<i>val</i>,<i>expiresAt</i>,<i>cost</i>,null)</tt>)}. */
36    public boolean shouldStore(Serializable key, Serializable val, Long expiresAt, Long cost) {
37      return shouldStore(key,val,expiresAt,cost,null);
38    }
39  
40    /**
41     * Returns <tt>false</tt>.
42     * @return <tt>false</tt>.
43     */
44    public boolean wantsSerializedForm() {
45      return false;
46    }
47  
48  }