MessageWriter.java

/* Copyright (c) 2011 Danish Maritime Authority.
 *
 * 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 net.maritimecloud.message;

import java.io.Closeable;
import java.io.Flushable;
import java.io.IOException;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.nio.ByteBuffer;
import java.util.List;
import java.util.Map;
import java.util.Set;

import net.maritimecloud.util.Binary;
import net.maritimecloud.util.Timestamp;
import net.maritimecloud.util.geometry.Position;
import net.maritimecloud.util.geometry.PositionTime;

/**
 * Abstract class for writing to message streams.
 *
 * @author Kasper Nielsen
 */
public interface MessageWriter extends Closeable, Flushable {

    /**
     * Returns the type of the underlying serialization protocol.
     *
     * @return the type of the underlying serialization protocol
     */
    MessageFormatType getFormatType();

    default void writeBinary(int tag, String name, byte[] bytes) throws IOException {
        writeBinary(tag, name, bytes, 0, bytes.length);
    }

    default void writeBinary(int tag, String name, byte[] bytes, int offset, int length) throws IOException {
        writeBinary(tag, name, Binary.copyFrom(bytes, offset, length));
    }

    default void writeBinary(int tag, String name, ByteBuffer buffer) throws IOException {
        writeBinary(tag, name, Binary.copyFrom(buffer));
    }


    void writeBinary(int tag, String name, Binary binary) throws IOException;

    /**
     * Writes a boolean.
     *
     * @param tag
     *            the tag value
     * @param name
     *            the tag name
     * @param value
     *            the boolean value to write
     * @throws IOException
     *             If an I/O error occurs
     */
    void writeBoolean(int tag, String name, Boolean value) throws IOException;

    /**
     * Writes a double.
     *
     * @param tag
     *            the tag value
     * @param name
     *            the tag name
     * @param value
     *            the double value to write
     * @throws IOException
     *             If an I/O error occurs
     */
    void writeDouble(int tag, String name, Double value) throws IOException;

    void writeEnum(int tag, String name, MessageEnum serializable) throws IOException;

    /**
     * Writes a float.
     *
     * @param tag
     *            the tag value
     * @param name
     *            the tag name
     * @param value
     *            the float value to write
     * @throws IOException
     *             If an I/O error occurs
     */
    void writeFloat(int tag, String name, Float value) throws IOException;

    /**
     * Writes an integer.
     *
     * @param tag
     *            the tag value
     * @param name
     *            the tag name
     * @param value
     *            the integer value to write
     * @throws IOException
     *             If an I/O error occurs
     */
    void writeInt(int tag, String name, Integer value) throws IOException;

    void writeVarInt(int tag, String name, BigInteger value) throws IOException;

    void writeDecimal(int tag, String name, BigDecimal value) throws IOException;

    void writePosition(int tag, String name, Position value) throws IOException;

    void writePositionTime(int tag, String name, PositionTime value) throws IOException;

    void writeTimestamp(int tag, String name, Timestamp value) throws IOException;


    /**
     * Writes a long.
     *
     * @param tag
     *            the tag value
     * @param name
     *            the tag name
     * @param value
     *            the long value to write
     * @throws IOException
     *             If an I/O error occurs
     */
    void writeInt64(int tag, String name, Long value) throws IOException;

    /**
     * Writes a list.
     *
     * @param tag
     *            the tag value
     * @param name
     *            the tag name
     * @param list
     *            the list to write
     * @param serializer
     *            the serializer for each element
     * @param <T>
     *            the type of elements
     *
     * @throws IOException
     *             If an I/O error occurs
     */
    <T> void writeList(int tag, String name, List<T> list, ValueSerializer<T> serializer) throws IOException;

    /**
     * Writes a map.
     *
     * @param tag
     *            the tag value
     * @param name
     *            the tag name
     * @param map
     *            the map to write
     * @param keySerializer
     *            the serializer for each key
     * @param valueSerializer
     *            the serializer for each value
     * @param <K>
     *            the type of keys in the map
     * @param <V>
     *            the type of values in the map
     * @throws IOException
     *             If an I/O error occurs
     */
    <K, V> void writeMap(int tag, String name, Map<K, V> map, ValueSerializer<K> keySerializer,
            ValueSerializer<V> valueSerializer) throws IOException;

    /**
     * Writes the specified message if it is non-null.
     *
     * @param tag
     *            the tag value
     * @param name
     *            the tag name
     * @param message
     *            the message to write
     * @param serializer
     *            the serializer for the message
     * @param <T>
     *            the type of message
     *
     * @throws IOException
     *             If an I/O error occurs
     */
    <T extends Message> void writeMessage(int tag, String name, T message, MessageSerializer<T> serializer)
            throws IOException;

    /**
     * Writes a set.
     *
     * @param tag
     *            the tag value
     * @param name
     *            the tag name
     * @param set
     *            the set to write
     * @param serializer
     *            the serializer for each element
     * @param <T>
     *            the type of elements
     * @throws IOException
     *             If an I/O error occurs
     */
    <T> void writeSet(int tag, String name, Set<T> set, ValueSerializer<T> serializer) throws IOException;

    /**
     * Writes a string.
     *
     * @param tag
     *            the tag value
     * @param name
     *            the tag name
     * @param value
     *            the string value to write
     * @throws IOException
     *             If an I/O error occurs
     */
    void writeText(int tag, String name, String value) throws IOException;
}
//
//
// public <T extends List<?> & MessageList> void writeList2(int tag, String name, T t) {
//
// }
//
// public <T> void writeList(int tag, String name, List<? extends T> list, MLS<T> mls) {
//
// List<Integer> ll = new ArrayList<>();
// writeList(tag, name, ll, MLS.TO_INT);
// }