KickJava   Java API By Example, From Geeks To Geeks.

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


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 org.objectweb.dream.message.ChunkType;
28 import org.objectweb.dream.message.ChunkTypeImpl;
29
30 /**
31  * Chunk interface for messages containing a key.
32  *
33  * @see Key
34  */
35 public interface KeyChunk
36 {
37
38   /** The default name for chunks of this type */
39   String JavaDoc DEFAULT_NAME = "keyChunk";
40
41   /** The Chunk type of chunks that implements this interface. */
42   ChunkType TYPE = new ChunkTypeImpl(KeyChunk.class, KeyChunkImpl.class);
43
44   /**
45    * Returns the key of this chunk.
46    *
47    * @return the key of this chunk.
48    */
49   Key getKey();
50
51   /**
52    * Sets the key of this chunk.
53    *
54    * @param key the key to be set.
55    */
56   void setKey(Key key);
57 }
Popular Tags