com.squareup.wire

Class Wire

java.lang.Object

com.squareup.wire.Wire

public final class Wire
extends Object

Encode and decode Wire protocol buffers.

Constructor Summary

Constructors

Constructor and Description
Wire(Class<?>... extensionClasses) Creates a new Wire that can encode and decode the extensions specified in extensionClasses.
Wire(List<Class<?>> extensionClasses) Creates a new Wire that can encode and decode the extensions specified in extensionClasses.

Method Summary

Methods

Modifier and Type	Method and Description
static <T> T	get(T value, T defaultValue) Returns value if it is not null; defaultValue otherwise.
<M extends Message> M	parseFrom(byte[] bytes, Class<M> messageClass) Reads a message of type messageClass from bytes and returns it.
<M extends Message> M	parseFrom(byte[] bytes, int offset, int count, Class<M> messageClass) Reads a message of type messageClass from the given range of bytes and returns it.
<M extends Message> M	parseFrom(InputStream input, Class<M> messageClass) Reads a message of type messageClass from the given InputStream and returns it.

Methods inherited from class java.lang.Object

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

Constructor Detail

Wire

public Wire(Class<?>... extensionClasses)

Creates a new Wire that can encode and decode the extensions specified in extensionClasses. Typically the classes in this list are generated and start with the "Ext_" prefix.

Wire

public Wire(List<Class<?>> extensionClasses)

Creates a new Wire that can encode and decode the extensions specified in extensionClasses. Typically the classes in this list are generated and start with the "Ext_" prefix.

Method Detail

parseFrom

public <M extends Message> M parseFrom(byte[] bytes,
                              Class<M> messageClass)
                            throws IOException

Reads a message of type messageClass from bytes and returns it.

Throws:

IOException

parseFrom

public <M extends Message> M parseFrom(byte[] bytes,
                              int offset,
                              int count,
                              Class<M> messageClass)
                            throws IOException

Reads a message of type messageClass from the given range of bytes and returns it.

Throws:

IOException

parseFrom

public <M extends Message> M parseFrom(InputStream input,
                              Class<M> messageClass)
                            throws IOException

Reads a message of type messageClass from the given InputStream and returns it.

Throws:

IOException

get

public static <T> T get(T value,
        T defaultValue)

Returns value if it is not null; defaultValue otherwise. This is used to conveniently return a default value when a value is null. For example,

 MyProto myProto = ...
 MyField field = Wire.get(myProto.f, MyProto.f_default);
 

will attempt to retrieve the value of the field 'f' defined by MyProto. If the field is null (i.e., unset), get will return its second argument, which in this case is the default value for the field 'f'.