1 /***
2 *
3 * Copyright 2004 Protique Ltd
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * 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 **/
18
19
20 package org.codehaus.activemq.message;
21
22 import java.io.DataOutput;
23 import java.io.IOException;
24
25 /***
26 * Allows instances implementing Packet to written to a DataOutput
27 */
28
29 public interface PacketWriter {
30
31 /***
32 * Return the type of Packet
33 *
34 * @return integer representation of the type of Packet
35 */
36
37 public int getPacketType();
38
39 /***
40 * @param packet
41 * @return true if this PacketWriter can write this type of Packet
42 */
43 public boolean canWrite(Packet packet);
44
45 /***
46 * Write a Packet instance to data output stream
47 *
48 * @param packet the instance to be seralized
49 * @param dataOut the output stream
50 * @throws IOException thrown if an error occurs
51 */
52
53 public void writePacket(Packet packet, DataOutput dataOut) throws IOException;
54
55 /***
56 * Serializes a Packet int a byte array
57 *
58 * @param packet
59 * @return the byte[]
60 * @throws IOException
61 */
62
63 public byte[] writePacketToByteArray(Packet packet) throws IOException;
64
65
66 }