io.protostuff

Interface Schema<T>

All Known Implementing Classes:

CustomSchema, Pipe.Schema

public interface Schema<T>

Handles the serialization and deserialization of a message/object tied to this.

Basically, any object can be serialized via protobuf. As long as its schema is provided, it does not need to implement Message. This was designed with "unobtrusive" in mind. The goal was to be able to serialize/deserialize any existing object without having to touch its source. This will enable you to customize the serialization of objects from 3rd party libraries.

Author:

David Yu

Date created:

Nov 9, 2009

Method Summary

Modifier and Type	Method and Description
String	getFieldName(int number) Gets the field name associated with the number.
int	getFieldNumber(String name) Gets the field number associated with the name.
boolean	isInitialized(T message) Returns true if there is no required field or if all the required fields are set.
void	mergeFrom(Input input, T message) Deserializes a message/object from the input.
String	messageFullName() Returns the full name of the message tied to this schema.
String	messageName() Returns the simple name of the message tied to this schema.
T	newMessage() Creates the message/object tied to this schema.
Class<? super T>	typeClass() Gets the class of the message.
void	writeTo(Output output, T message) Serializes a message/object to the output.

Method Detail

getFieldName

String getFieldName(int number)

Gets the field name associated with the number. This is particularly useful when serializing to different formats (Eg. JSON). When using numeric field names:

 return String.valueOf(number);
 

getFieldNumber

int getFieldNumber(String name)

Gets the field number associated with the name. This is particularly useful when serializing to different formats (Eg. JSON). When using numeric field names:

 return Integer.parseInt(name);
 

isInitialized

boolean isInitialized(T message)

Returns true if there is no required field or if all the required fields are set.

newMessage

T newMessage()

Creates the message/object tied to this schema.

messageName

String messageName()

Returns the simple name of the message tied to this schema. Allows custom schemas to provide a custom name other than typeClass().getSimpleName();

messageFullName

String messageFullName()

Returns the full name of the message tied to this schema. Allows custom schemas to provide a custom name other than typeClass().getName();

typeClass

Class<? super T> typeClass()

Gets the class of the message.

mergeFrom

void mergeFrom(Input input,
               T message)
        throws IOException

Deserializes a message/object from the input.

Throws:

IOException

writeTo

void writeTo(Output output,
             T message)
      throws IOException

Serializes a message/object to the output.

Throws:

IOException