net.maritimecloud.message

Interface MessageWriter

All Superinterfaces:

AutoCloseable, Closeable, Flushable

public interface MessageWriter
extends Closeable, Flushable

Abstract class for writing to message streams.

Author:

Kasper Nielsen

Method Summary

Modifier and Type	Method and Description
MessageFormatType	getFormatType() Returns the type of the underlying serialization protocol.
void	writeBinary(int tag, String name, Binary binary)
default void	writeBinary(int tag, String name, byte[] bytes)
default void	writeBinary(int tag, String name, byte[] bytes, int offset, int length)
default void	writeBinary(int tag, String name, ByteBuffer buffer)
void	writeBoolean(int tag, String name, Boolean value) Writes a boolean.
void	writeDecimal(int tag, String name, BigDecimal value)
void	writeDouble(int tag, String name, Double value) Writes a double.
void	writeEnum(int tag, String name, MessageEnum serializable)
void	writeFloat(int tag, String name, Float value) Writes a float.
void	writeInt(int tag, String name, Integer value) Writes an integer.
void	writeInt64(int tag, String name, Long value) Writes a long.
<T> void	writeList(int tag, String name, List<T> list, ValueSerializer<T> serializer) Writes a list.
<K,V> void	writeMap(int tag, String name, Map<K,V> map, ValueSerializer<K> keySerializer, ValueSerializer<V> valueSerializer) Writes a map.
<T extends Message> void	writeMessage(int tag, String name, T message, MessageSerializer<T> serializer) Writes the specified message if it is non-null.
void	writePosition(int tag, String name, Position value)
void	writePositionTime(int tag, String name, PositionTime value)
<T> void	writeSet(int tag, String name, Set<T> set, ValueSerializer<T> serializer) Writes a set.
void	writeText(int tag, String name, String value) Writes a string.
void	writeTimestamp(int tag, String name, Timestamp value)
void	writeVarInt(int tag, String name, BigInteger value)

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface java.io.Flushable

flush

Method Detail

getFormatType

MessageFormatType getFormatType()

Returns the type of the underlying serialization protocol.

Returns:

the type of the underlying serialization protocol

writeBinary

default void writeBinary(int tag,
                         String name,
                         byte[] bytes)
                  throws IOException

Throws:

IOException

writeBinary

default void writeBinary(int tag,
                         String name,
                         byte[] bytes,
                         int offset,
                         int length)
                  throws IOException

Throws:

IOException

writeBinary

default void writeBinary(int tag,
                         String name,
                         ByteBuffer buffer)
                  throws IOException

Throws:

IOException

writeBinary

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

Throws:

IOException

writeBoolean

void writeBoolean(int tag,
                  String name,
                  Boolean value)
           throws IOException

Writes a boolean.

Parameters:

tag - the tag value

name - the tag name

value - the boolean value to write

Throws:

IOException - If an I/O error occurs

writeDouble

void writeDouble(int tag,
                 String name,
                 Double value)
          throws IOException

Writes a double.

Parameters:

tag - the tag value

name - the tag name

value - the double value to write

Throws:

IOException - If an I/O error occurs

writeEnum

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

Throws:

IOException

writeFloat

void writeFloat(int tag,
                String name,
                Float value)
         throws IOException

Writes a float.

Parameters:

tag - the tag value

name - the tag name

value - the float value to write

Throws:

IOException - If an I/O error occurs

writeInt

void writeInt(int tag,
              String name,
              Integer value)
       throws IOException

Writes an integer.

Parameters:

tag - the tag value

name - the tag name

value - the integer value to write

Throws:

IOException - If an I/O error occurs

writeVarInt

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

Throws:

IOException

writeDecimal

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

Throws:

IOException

writePosition

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

Throws:

IOException

writePositionTime

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

Throws:

IOException

writeTimestamp

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

Throws:

IOException

writeInt64

void writeInt64(int tag,
                String name,
                Long value)
         throws IOException

Writes a long.

Parameters:

tag - the tag value

name - the tag name

value - the long value to write

Throws:

IOException - If an I/O error occurs

writeList

<T> void writeList(int tag,
                   String name,
                   List<T> list,
                   ValueSerializer<T> serializer)
            throws IOException

Writes a list.

Type Parameters:

T - the type of elements

Parameters:

tag - the tag value

name - the tag name

list - the list to write

serializer - the serializer for each element

Throws:

IOException - If an I/O error occurs

writeMap

<K,V> void writeMap(int tag,
                    String name,
                    Map<K,V> map,
                    ValueSerializer<K> keySerializer,
                    ValueSerializer<V> valueSerializer)
             throws IOException

Writes a map.

Type Parameters:

K - the type of keys in the map

V - the type of values in the map

Parameters:

tag - the tag value

name - the tag name

map - the map to write

keySerializer - the serializer for each key

valueSerializer - the serializer for each value

Throws:

IOException - If an I/O error occurs

writeMessage

<T extends Message> void writeMessage(int tag,
                                      String name,
                                      T message,
                                      MessageSerializer<T> serializer)
                               throws IOException

Writes the specified message if it is non-null.

Type Parameters:

T - the type of message

Parameters:

tag - the tag value

name - the tag name

message - the message to write

serializer - the serializer for the message

Throws:

IOException - If an I/O error occurs

writeSet

<T> void writeSet(int tag,
                  String name,
                  Set<T> set,
                  ValueSerializer<T> serializer)
           throws IOException

Writes a set.

Type Parameters:

T - the type of elements

Parameters:

tag - the tag value

name - the tag name

set - the set to write

serializer - the serializer for each element

Throws:

IOException - If an I/O error occurs

writeText

void writeText(int tag,
               String name,
               String value)
        throws IOException

Writes a string.

Parameters:

tag - the tag value

name - the tag name

value - the string value to write

Throws:

IOException - If an I/O error occurs