KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > caching > validity > EventValidity


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.validity;
17
18 import org.apache.excalibur.source.SourceValidity;
19
20 /**
21  * The SourceValidity object for cache invalidation based on
22  * external events.
23  *
24  * @author Geoff Howard (ghoward@apache.org)
25  * @version $Id: EventValidity.java 30932 2004-07-29 17:35:38Z vgritsenko $
26  */
27 public class EventValidity implements SourceValidity {
28     
29     private Event m_event;
30     
31     /**
32      * Constructor requires any subclass of Event.
33      * @param ev
34      */
35     public EventValidity(Event ev) {
36         m_event = ev;
37     }
38     
39     /**
40      * Returns the specific Event this validity is based on.
41      *
42      * @return Event
43      */
44     public Event getEvent() {
45         return m_event;
46     }
47
48     /**
49      * Basic implementation is always valid until event signals
50      * otherwise. May never need other behavior.
51      */
52     public int isValid() {
53         return VALID;
54     }
55
56     /**
57      * Older style of isValid
58      */
59     public int isValid(SourceValidity sv) {
60         if (sv instanceof EventValidity) {
61             return VALID;
62         }
63         return INVALID;
64     }
65     
66     
67     public boolean equals(Object JavaDoc o) {
68         if (o instanceof EventValidity) {
69             return m_event.equals(((EventValidity)o).getEvent());
70         }
71         return false;
72     }
73     
74     public int hashCode() {
75         return m_event.hashCode();
76     }
77
78     public String JavaDoc toString() {
79         return "EventValidity[" + m_event + "]";
80     }
81 }
82
Popular Tags