KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > dream > pushwithreturn > Key


1 /**
2  * Dream
3  * Copyright (C) 2003-2004 INRIA Rhone-Alpes
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Contact : dream@objectweb.org
20  *
21  * Initial developer(s): Vivien Quema
22  * Contributor(s):
23  */
24
25 package org.objectweb.dream.pushwithreturn;
26
27 import java.io.Serializable JavaDoc;
28
29 /**
30  * This interface defines a Key. Keys are used by the
31  * <code>PushWithReturn</code> protocol to identify messages.
32  * <p>
33  * A key can correspond to all possible keys. For detecting such a key, called
34  * "AllKey" this interface defines the <code>isAll</code> method that returns
35  * <code>true</code> if this is the case.
36  * <p>
37  * <i>Note: </i> keys must implement <code>equals</code> and
38  * <code>hashcode</code> methods.
39  */
40 public interface Key extends Serializable JavaDoc
41 {
42   /**
43    * Checks whether this key correspond to all possible keys generated by the
44    * generator that made it.
45    *
46    * @return <code>true</code> if this key correspond to all keys generated by
47    * the generator that made it.
48    */
49   boolean isAll();
50 }
Popular Tags