zipkin2.internal

Class JsonCodec

java.lang.Object

zipkin2.internal.JsonCodec

public final class JsonCodec
extends Object

This explicitly constructs instances of model classes via manual parsing for a number of reasons.

• Eliminates the need to keep separate model classes for proto3 vs json
• Avoids magic field initialization which, can miss constructor guards
• Allows us to safely re-use the json form in toString methods
• Encourages logic to be based on the json shape of objects
• Ensures the order and naming of the fields in json is stable

There is the up-front cost of creating this, and maintenance of this to consider. However, this should be easy to justify as these objects don't change much at all.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonCodec.JsonReader
static interface	JsonCodec.JsonReaderAdapter<T>

Constructor Summary

Constructors

Constructor and Description
JsonCodec()

Method Summary

Modifier and Type	Method and Description
static <T> boolean	read(JsonCodec.JsonReaderAdapter<T> adapter, byte[] bytes, Collection<T> out)
static <T> List<T>	readList(JsonCodec.JsonReaderAdapter<T> adapter, byte[] bytes)
static <T> boolean	readList(JsonCodec.JsonReaderAdapter<T> adapter, byte[] bytes, Collection<T> out)
static <T> T	readOne(JsonCodec.JsonReaderAdapter<T> adapter, byte[] bytes)
static <T> byte[]	write(Buffer.Writer<T> writer, T value) Inability to encode is a programming bug.
static <T> byte[]	writeList(Buffer.Writer<T> writer, List<T> value)
static <T> void	writeList(Buffer.Writer<T> writer, List<T> value, Buffer b)
static <T> int	writeList(Buffer.Writer<T> writer, List<T> value, byte[] out, int pos)

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonCodec

public JsonCodec()

Method Detail

read

public static <T> boolean read(JsonCodec.JsonReaderAdapter<T> adapter,
                               byte[] bytes,
                               Collection<T> out)

readOne

@Nullable
public static <T> T readOne(JsonCodec.JsonReaderAdapter<T> adapter,
                                      byte[] bytes)

readList

public static <T> boolean readList(JsonCodec.JsonReaderAdapter<T> adapter,
                                   byte[] bytes,
                                   Collection<T> out)

readList

public static <T> List<T> readList(JsonCodec.JsonReaderAdapter<T> adapter,
                                   byte[] bytes)

write

public static <T> byte[] write(Buffer.Writer<T> writer,
                               T value)

Inability to encode is a programming bug.

writeList

public static <T> byte[] writeList(Buffer.Writer<T> writer,
                                   List<T> value)

writeList

public static <T> int writeList(Buffer.Writer<T> writer,
                                List<T> value,
                                byte[] out,
                                int pos)

writeList

public static <T> void writeList(Buffer.Writer<T> writer,
                                 List<T> value,
                                 Buffer b)