BinaryMessage.java

/*
 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores
 * CA 94065 USA or visit www.oracle.com if you need additional information or
 * have any questions.
 */

package javax.wireless.messaging;

/**
 * An interface representing a binary message. This is a subinterface of
 * {@link Message Message} which contains methods to get and set the
 * binary data payload. The <code>setPayloadData()</code>
 * method sets the value of the payload in the
 * data container without any checking whether the value
 * is valid in any way. Methods for manipulating the address portion of
 * the message are inherited from <tt>Message</tt>.
 *
 * <p>Object instances implementing this interface are just
 * containers for the data that is passed in.
 * </p>
 */

public interface BinaryMessage extends Message {

    /**
     * Returns the message payload data as an array
     * of bytes.
     *
     * <p>Returns <code>null</code>, if the payload for the message
     * is not set.
     * </p>
     * <p>The returned byte array is a reference to the
     * byte array of this message and the same reference
     * is returned for all calls to this method made before the
     * next call to <code>setPayloadData</code>.
     *
     * @return the payload data of this message or
     * <code>null</code> if the data has not been set
     * @see #setPayloadData
     */ 
    public byte[] getPayloadData();

    /**
     * Sets the payload data of this message. The payload may
     * be set to <code>null</code>.
     * <p>Setting the payload using this method only sets the
     * reference to the byte array. Changes made to the contents
     * of the byte array subsequently affect the contents of this
     * <code>BinaryMessage</code> object. Therefore, applications
     * should not reuse this byte array before the message is sent and the
     * <code>MessageConnection.send</code> method returns.
     * </p>
     * @param data payload data as a byte array
     * @see #getPayloadData
     */
    public void setPayloadData(byte[] data);

}