Package org.tribuo.protos

package org.tribuo.protos

Classes which control the serialization of Tribuo objects to and from protocol buffers.

There is an automatic serialization mechanism which requires the fields to be annotated with ProtoSerializableField and similar. The enclosing class must implement ProtoSerializable and be annotated with ProtoSerializableClass. This mechanism can serialize:

• primitive types
• Strings
• classes which implement ProtoSerializable
• lists, sets and maps of supported types

Maps may be serialized in multiple ways, as protobuf does not support the full set of map type parameters that Java does. The variants are:

• ProtoSerializableMapField annotation directly serializes the map as a protobuf map
• ProtoSerializableKeysValuesField serializes the map as two repeated fields for the keys and values
• ProtoSerializableMapValuesField serializes just the values from the map

Related Packages

Package	Description
org.tribuo	Provides the core interfaces and classes for using Tribuo.

Class	Description
ProtoSerializable<T extends com.google.protobuf.Message>	Interface for serializing an implementing object to the specified protobuf.
ProtoSerializableClass	Mark a class as being ProtoSerializable and specify the class type used to serialize the "serialized_data".
ProtoSerializableField	Annotation which denotes that a field should be part of the protobuf serialized representation.
ProtoSerializableKeysValuesField	Annotation which denotes that the map field this is applied to is serialized as two repeated fields, one for keys and one for values.
ProtoSerializableMapField	Annotation which denotes that a map field should be part of the protobuf serialized representation.
ProtoSerializableMapValuesField	Annotation which denotes that the map field this is applied to is serialized as a list of values.
ProtoUtil	Utilities for working with Tribuo protobufs.