View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.jetspeed.cache.file;
18  
19  import java.io.File;
20  import java.util.Date;
21  
22  /***
23   * @author <a href="weaver@apache.org">Scott T. Weaver</a>
24   *
25   */
26  public interface FileCacheEntry
27  {
28      /***
29       * Get the file descriptor
30       *
31       * @return the file descriptor
32       */
33      File getFile();
34  
35      /***
36       * Set the file descriptor
37       *
38       * @param file the new file descriptor
39       */
40      void setFile( File file );
41  
42      /***
43       * Set the cache's last accessed stamp
44       *
45       * @param lastAccessed the cache's last access stamp
46       */
47      void setLastAccessed( long lastAccessed );
48  
49      /***
50       * Get the cache's lastAccessed stamp
51       *
52       * @return the cache's last accessed stamp
53       */
54      long getLastAccessed();
55  
56      /***
57       * Set the cache's last modified stamp
58       *
59       * @param lastModified the cache's last modified stamp
60       */
61      void setLastModified( Date lastModified );
62  
63      /***
64       * Get the entry's lastModified stamp (which may be stale compared to file's stamp)
65       *
66       * @return the last modified stamp
67       */
68      Date getLastModified();
69  
70      /***
71       * Set the Document in the cache
72       *
73       * @param document the document being cached
74       */
75      void setDocument( Object document );
76  
77      /***
78       * Get the Document
79       *
80       * @return the document being cached
81       */
82      Object getDocument();
83  }