com.google.code.proto.streamio

Class PBStreamReader<T extends com.google.protobuf.GeneratedMessage>

java.lang.Object

com.google.code.proto.streamio.PBStreamReader<T>

public class PBStreamReader<T extends com.google.protobuf.GeneratedMessage>
extends Object

A reader for an input stream of Google protocol buffer generated messages.

Usage:
PBStreamReader<YourProtocolBufferMessage> pbReader = new PBStreamReader();
Builder builder = YourProtocolBufferMessage.newBuilder();
List<YourProtocolBufferMessage> messages = pbReader.read(inStream, builder);

Author:

nichole

Constructor Summary

Constructors

Constructor and Description
PBStreamReader() Default constructor that uses the signed byte marker wire helper class.
PBStreamReader(ByteOption byteOption) Alternate constructor for use with a specialized IPBWireByteMarkerHelper

Method Summary

Modifier and Type	Method and Description
List<T>	read(InputStream inStream, com.google.protobuf.AbstractMessage.Builder messageBuilder) Read instances of GeneratedMessage from the input stream and use the given builder to unmarshal the messages.
void	read(InputStream inStream, com.google.protobuf.AbstractMessage.Builder messageBuilder, IPBStreamReaderCallback callback) Read instances of GeneratedMessage from the input stream, sending each message parsed from the stream via the callback.

Methods inherited from class java.lang.Object

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

Constructor Detail

PBStreamReader

public PBStreamReader()

Default constructor that uses the signed byte marker wire helper class.

Type Parameters:

T - Parameterized type that is a specialization of GeneratedMessage

PBStreamReader

public PBStreamReader(ByteOption byteOption)

Alternate constructor for use with a specialized IPBWireByteMarkerHelper

Type Parameters:

T - Parameterized type that is a specialization of GeneratedMessage

Parameters:

byteOption - option to choose signed bytes or unsigned bytes when writing to stream. null results in a default UNSIGNED.

Method Detail

read

public void read(InputStream inStream,
                 com.google.protobuf.AbstractMessage.Builder messageBuilder,
                 IPBStreamReaderCallback callback)
          throws IOException,
                 InstantiationException,
                 IllegalAccessException

Read instances of GeneratedMessage from the input stream, sending each message parsed from the stream via the callback.

Parameters:

inStream - input stream holding delimeters and encoded generated messages.

messageBuilder - protocol buffer message builder to deserialize message.

callback - class to callback with messages read from inStream

Throws:

IOException

InstantiationException

IllegalAccessException

read

public List<T> read(InputStream inStream,
                    com.google.protobuf.AbstractMessage.Builder messageBuilder)
             throws IOException,
                    InstantiationException,
                    IllegalAccessException

Read instances of GeneratedMessage from the input stream and use the given builder to unmarshal the messages.

Parameters:

inStream - input stream holding delimeters and encoded generated messages.

messageBuilder - protocol buffer message builder

Returns:

list of GeneratedMessage instances decoded and de-serialized from input stream

Throws:

IOException

InstantiationException

IllegalAccessException