KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > cache > invalidation > Invalidatable


1 /*
2 * JBoss, Home of Professional Open Source
3 * Copyright 2005, JBoss Inc., and individual contributors as indicated
4 * by the @authors tag. See the copyright.txt in the distribution for a
5 * full listing of individual contributors.
6 *
7 * This is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU Lesser General Public License as
9 * published by the Free Software Foundation; either version 2.1 of
10 * the License, or (at your option) any later version.
11 *
12 * This software is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this software; if not, write to the Free
19 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21 */
22 package org.jboss.cache.invalidation;
23
24 import java.io.Serializable JavaDoc;
25
26 /**
27  * Represent an invalidable resource, such as a cache
28  * @see InvalidationGroup
29  * @author <a HREF="mailto:sacha.labourey@cogito-info.ch">Sacha Labourey</a>.
30  * @version $Revision: 1.1 $
31  *
32  * <p><b>Revisions:</b>
33  *
34  * <p><b>21. septembre 2002 Sacha Labourey:</b>
35  * <ul>
36  * <li> First implementation </li>
37  * </ul>
38  */
39
40 public interface Invalidatable
41 {
42    /**
43     * Indicates that the resource with the given key should be invalidated (i.e. removed
44     * from cache)
45     * @param key Key of the resource to be invalidated
46     */
47    public void isInvalid (Serializable JavaDoc key);
48    
49    /** Indicates that the resources with the give keys should be invalidated (i.e.
50     * removed from cache)
51     *
52     * @param keys Keys of the resources to be invalidated
53     */
54    public void areInvalid (Serializable JavaDoc[] keys);
55
56    /**
57     * All entries should be invalidated.
58     */
59    public void invalidateAll();
60 }
Popular Tags