CacheValidity


1   /*
2    * Copyright 1999-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.cocoon.caching;
17  
18  import java.io.Serializable  ;
19  
20  /**
21   * A CacheValidity object contains all information for one pipeline component
22   * to check if it is still valid.<br>
23   * For example, the FileGenerator stores only the timestamp for the read
24   * xml file in this container.
25   * Although this interface is deprecated it is still used for compatibility!
26   *
27   * @deprecated Use the Avalon Excalibur SourceValidity implementations instead
28   * @author <a HREF="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
29   * @version CVS $Id: CacheValidity.java 30932 2004-07-29 17:35:38Z vgritsenko $
30   */
31  public interface CacheValidity extends Serializable   {
32  
33      /**
34       * Check if the component is still valid.
35       * This is only true, if the incoming CacheValidity is of the same
36       * type and has the same values.
37       */
38      boolean isValid(CacheValidity validity);
39  
40      /**
41       * Creates text represenation of the validity object.
42       * This is used to create fake 'lastModificationDate' for cocoon: sources.
43       * <p>Due to changes in source API, this method is no longer needed,
44       * starting with Cocoon 2.1.
45       */
46      String   toString();
47  }
48
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags