org.red5.io.amf3.IDataOutput Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ant-media-server Show documentation
Ant Media Server supports RTMP, RTSP, MP4, HLS, WebRTC, Adaptive Streaming, etc.
There is a newer version: 2.11.3
/*
 * RED5 Open Source Media Server - https://github.com/Red5/ Copyright 2006-2016 by respective authors (see below). All rights reserved. Licensed under the Apache License, Version
 * 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless
 * required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language governing permissions and limitations under the License.
 */

package org.red5.io.amf3;

import java.nio.ByteOrder;

/**
 * Interface implemented by classes that provide a way to store custom objects.
 * 
 * @see IExternalizable#writeExternal(IDataOutput)
 * @see Adobe Livedocs (external)
 */
public interface IDataOutput {

    /**
     * Return the byteorder used when storing values.
     * 
     * @return the byteorder
     */
    public ByteOrder getEndian();

    /**
     * Set the byteorder to use when storing values.
     * 
     * @param endian
     *            the byteorder to use
     */
    public void setEndian(ByteOrder endian);

    /**
     * Write boolean value.
     * 
     * @param value
     *            the value
     */
    public void writeBoolean(boolean value);

    /**
     * Write signed byte value.
     * 
     * @param value
     *            the value
     */
    public void writeByte(byte value);

    /**
     * Write multiple bytes.
     * 
     * @param bytes
     *            the bytes
     */
    public void writeBytes(byte[] bytes);

    /**
     * Write multiple bytes from given offset.
     * 
     * @param bytes
     *            the bytes
     * @param offset
     *            offset in bytes to start writing from
     */
    public void writeBytes(byte[] bytes, int offset);

    /**
     * Write given number of bytes from given offset.
     * 
     * @param bytes
     *            the bytes
     * @param offset
     *            offset in bytes to start writing from
     * @param length
     *            number of bytes to write
     */
    public void writeBytes(byte[] bytes, int offset, int length);

    /**
     * Write double-precision floating point value.
     * 
     * @param value
     *            the value
     */
    public void writeDouble(double value);

    /**
     * Write single-precision floating point value.
     * 
     * @param value
     *            the value
     */
    public void writeFloat(float value);

    /**
     * Write signed integer value.
     * 
     * @param value
     *            the value
     */
    public void writeInt(int value);

    /**
     * Write string in given character set.
     * 
     * @param value
     *            the string
     * @param encoding
     *            the character set
     */
    public void writeMultiByte(String value, String encoding);

    /**
     * Write arbitrary object.
     * 
     * @param value
     *            the object
     */
    public void writeObject(Object value);

    /**
     * Write signed short value.
     * 
     * @param value
     *            the value
     */
    public void writeShort(short value);

    /**
     * Write unsigned integer value.
     * 
     * @param value
     *            the value
     */
    public void writeUnsignedInt(long value);

    /**
     * Write UTF-8 encoded string.
     * 
     * @param value
     *            the string
     */
    public void writeUTF(String value);

    /**
     * Write UTF-8 encoded string as byte array. This string is stored without informations about its length, so {@link IDataInput#readUTFBytes(int)} must be used to load it.
     * 
     * @param value
     *            the string
     */
    public void writeUTFBytes(String value);

}