01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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.cocoon.caching.validity;
18:
19: import org.apache.excalibur.source.SourceValidity;
20:
21: /**
22: * The SourceValidity object for cache invalidation based on
23: * external events.
24: *
25: * @author Geoff Howard (ghoward@apache.org)
26: * @version $Id: EventValidity.java 433543 2006-08-22 06:22:54Z crossley $
27: */
28: public class EventValidity implements SourceValidity {
29:
30: private Event m_event;
31:
32: /**
33: * Constructor requires any subclass of Event.
34: * @param ev
35: */
36: public EventValidity(Event ev) {
37: m_event = ev;
38: }
39:
40: /**
41: * Returns the specific Event this validity is based on.
42: *
43: * @return Event
44: */
45: public Event getEvent() {
46: return m_event;
47: }
48:
49: /**
50: * Basic implementation is always valid until event signals
51: * otherwise. May never need other behavior.
52: */
53: public int isValid() {
54: return VALID;
55: }
56:
57: /**
58: * Older style of isValid
59: */
60: public int isValid(SourceValidity sv) {
61: if (sv instanceof EventValidity) {
62: return VALID;
63: }
64: return INVALID;
65: }
66:
67: public boolean equals(Object 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 toString() {
79: return "EventValidity[" + m_event + "]";
80: }
81: }
|