io.higgs.boson.serialization.v1

Class BosonWriter

java.lang.Object

io.higgs.boson.serialization.v1.BosonWriter

public class BosonWriter
extends Object

Author:

Courtney Robinson

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_RECURSION_DEPTH The maximum number of times methods can invoked themselves.
protected Set<ReadMutator>	mutators
protected AtomicInteger	reference
protected HashMap<Object,Integer>	references
static Charset	utf8

Constructor Summary

Constructors

Constructor and Description
BosonWriter()
BosonWriter(Set<ReadMutator> mutators)

Method Summary

Methods

Modifier and Type	Method and Description
io.netty.buffer.ByteBuf	serialize(BosonMessage msg) Serializes a BosonMessage to the wire format specified by the protocol spec
io.netty.buffer.ByteBuf	serialize(Object msg) Serialize any object to a series of bytes.
void	serializeRequest(io.netty.buffer.ByteBuf buffer, BosonMessage msg)
void	serializeResponse(io.netty.buffer.ByteBuf buffer, BosonMessage msg)
void	validateAndWriteType(io.netty.buffer.ByteBuf buffer, Object param)
void	writeArray(io.netty.buffer.ByteBuf buffer, Object[] value) Write an array of any supported boson type to the given buffer.
void	writeBoolean(io.netty.buffer.ByteBuf buffer, boolean b)
void	writeByte(io.netty.buffer.ByteBuf buffer, byte b)
void	writeChar(io.netty.buffer.ByteBuf buffer, char c)
void	writeDouble(io.netty.buffer.ByteBuf buffer, double d)
void	writeEnum(io.netty.buffer.ByteBuf buf, Enum param)
void	writeFloat(io.netty.buffer.ByteBuf buffer, float f)
void	writeInt(io.netty.buffer.ByteBuf buffer, int i)
void	writeList(io.netty.buffer.ByteBuf buffer, List<Object> value)
void	writeLong(io.netty.buffer.ByteBuf buffer, long l)
void	writeMap(io.netty.buffer.ByteBuf buffer, Map<?,?> value)
void	writeNull(io.netty.buffer.ByteBuf buffer)
void	writePolo(io.netty.buffer.ByteBuf buffer, Object obj, int ref) Serialize any* Java object.
void	writeSet(io.netty.buffer.ByteBuf buffer, Set<Object> value)
void	writeShort(io.netty.buffer.ByteBuf buffer, short s)
void	writeString(io.netty.buffer.ByteBuf buffer, String s)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_RECURSION_DEPTH

public static final int MAX_RECURSION_DEPTH

The maximum number of times methods can invoked themselves.

See Also:

Constant Field Values

utf8

public static final Charset utf8

references

protected final HashMap<Object,Integer> references

reference

protected final AtomicInteger reference

mutators

protected final Set<ReadMutator> mutators

Constructor Detail

BosonWriter

public BosonWriter()

BosonWriter

public BosonWriter(Set<ReadMutator> mutators)

Method Detail

serialize

public io.netty.buffer.ByteBuf serialize(Object msg)

Serialize any object to a series of bytes. This is the same as serialize(io.higgs.boson.BosonMessage) except it doesn't contain any Boson headers required for network transport

Parameters:

msg - the message to serialize

Returns:

a series of bytes representing the message

serialize

public io.netty.buffer.ByteBuf serialize(BosonMessage msg)

Serializes a BosonMessage to the wire format specified by the protocol spec

Parameters:

msg - the message to serialize

Returns:

the message serialized to a series of bytes

serializeResponse

public void serializeResponse(io.netty.buffer.ByteBuf buffer,
                     BosonMessage msg)

serializeRequest

public void serializeRequest(io.netty.buffer.ByteBuf buffer,
                    BosonMessage msg)

writeByte

public void writeByte(io.netty.buffer.ByteBuf buffer,
             byte b)

writeNull

public void writeNull(io.netty.buffer.ByteBuf buffer)

writeShort

public void writeShort(io.netty.buffer.ByteBuf buffer,
              short s)

writeInt

public void writeInt(io.netty.buffer.ByteBuf buffer,
            int i)

writeLong

public void writeLong(io.netty.buffer.ByteBuf buffer,
             long l)

writeFloat

public void writeFloat(io.netty.buffer.ByteBuf buffer,
              float f)

writeDouble

public void writeDouble(io.netty.buffer.ByteBuf buffer,
               double d)

writeBoolean

public void writeBoolean(io.netty.buffer.ByteBuf buffer,
                boolean b)

writeChar

public void writeChar(io.netty.buffer.ByteBuf buffer,
             char c)

writeString

public void writeString(io.netty.buffer.ByteBuf buffer,
               String s)

writeEnum

public void writeEnum(io.netty.buffer.ByteBuf buf,
             Enum param)

writeList

public void writeList(io.netty.buffer.ByteBuf buffer,
             List<Object> value)

writeSet

public void writeSet(io.netty.buffer.ByteBuf buffer,
            Set<Object> value)

writeArray

public void writeArray(io.netty.buffer.ByteBuf buffer,
              Object[] value)

Write an array of any supported boson type to the given buffer. If the buffer contains any unsupported type, this will fail by throwing an UnsupportedBosonTypeException

Parameters:

value - the value to write

writeMap

public void writeMap(io.netty.buffer.ByteBuf buffer,
            Map<?,?> value)

writePolo

public void writePolo(io.netty.buffer.ByteBuf buffer,
             Object obj,
             int ref)

Serialize any* Java object. Circular reference support based on http://beza1e1.tuxen.de/articles/deepcopy.html http://stackoverflow.com/questions/5157764/java-detect-circular-references-during-custom-cloning

Parameters:

obj - the object to write

ref -

validateAndWriteType

public void validateAndWriteType(io.netty.buffer.ByteBuf buffer,
                        Object param)

Parameters:

buffer - the buffer to write to

param - the param to write to the buffer