01: /*
02: *
03: *
04: * Copyright 1990-2007 Sun Microsystems, Inc. All Rights Reserved.
05: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
06: *
07: * This program is free software; you can redistribute it and/or
08: * modify it under the terms of the GNU General Public License version
09: * 2 only, as published by the Free Software Foundation.
10: *
11: * This program is distributed in the hope that it will be useful, but
12: * WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14: * General Public License version 2 for more details (a copy is
15: * included at /legal/license.txt).
16: *
17: * You should have received a copy of the GNU General Public License
18: * version 2 along with this work; if not, write to the Free Software
19: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA
21: *
22: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
23: * Clara, CA 95054 or visit www.sun.com if you need additional
24: * information or have any questions.
25: */
26:
27: package com.sun.tck.wma;
28:
29: /**
30: * An interface representing a binary message.
31: */
32: public interface BinaryMessage extends Message {
33:
34: /**
35: * Returns an array of bytes representing the payload data
36: * of the message, or <code>null</code> if it isn't set.
37: *
38: * <p>A reference to the byte array of this binary message
39: * is returned. It is the same for all calls to this method
40: * made before <code>setPayloadData</code> is called the
41: * next time.
42: *
43: * @return <code>null</code> if the data hasn't been set,
44: * or this message's payload data
45: * @see #setPayloadData
46: */
47: public byte[] getPayloadData();
48:
49: /**
50: * Sets the payload data of this binary message. It may
51: * be set to <code>null</code>.
52: * <p>This method actually sets the reference to the byte array.
53: * Changes made to this array subsequently affect this
54: * <code>BinaryMessage</code> object's contents. Therefore, this array
55: * should not be reused by the applications until the message is sent and
56: * <code>MessageConnection.send</code> returned.
57: * </p>
58: * @param data payload data represented as a byte array
59: * @see #getPayloadData
60: */
61: public void setPayloadData(byte[] data);
62: }
|