KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > dream > message > Chunk


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): Matthieu Leclercq
22  * Contributor(s):
23  */
24
25 package org.objectweb.dream.message;
26
27 import org.objectweb.dream.pool.Recyclable;
28
29 /**
30  * An interface that represent a chunk.
31  * <p>
32  * <b>WARNING </b>: this class is not designed to be implemented by every chunk
33  * returned by {@link org.objectweb.dream.message.Message#getChunk(String)}.
34  * But should be implemented by class implementing a single chunk interface, and
35  * supposed to be used in extensible message
36  */
37 public interface Chunk extends Recyclable
38 {
39
40   /**
41    * Returns the id of the message manager that created this chunk.
42    *
43    * @return the id of the message manager that created this chunk.
44    */
45   short getMessageManagerId();
46
47   /**
48    * Sets the id of the message manager that created this chunk.
49    *
50    * @param messageManagerId the id to set.
51    */
52   void setMessageManagerId(short messageManagerId);
53
54   /**
55    * Returns the type of this chunk.
56    *
57    * @return the type of this chunk.
58    */
59   ChunkType getType();
60
61   /**
62    * Transferts the state of this chunk into the specified new instance.
63    *
64    * @param newInstance the new instance of chunk.
65    */
66   void transfertState(Chunk newInstance);
67 }
Popular Tags