net.morimekta.providence.streams

Class MessageStreams

java.lang.Object

net.morimekta.providence.streams.MessageStreams

public class MessageStreams
extends Object

Helper class to create streams that read providence messages.

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	READABLE_ENTRY_SEP

Constructor Summary

Constructors

Constructor and Description
MessageStreams()

Method Summary

Modifier and Type	Method and Description
static <T extends PMessage<T>,F extends PField> Stream<T>	file(File file, Serializer serializer, PStructDescriptor<T,F> descriptor) Read a file containing entries of a given type.
static <T extends PMessage<T>,F extends PField> Stream<T>	resource(String resource, Serializer serializer, PStructDescriptor<T,F> descriptor) Read a file containing entries of a given type.
static <T extends PMessage<T>,F extends PField> Stream<T>	stream(InputStream in, Serializer serializer, PStructDescriptor<T,F> descriptor) Read a input stream containing entries of a given type.

Methods inherited from class java.lang.Object

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

Field Detail

READABLE_ENTRY_SEP

public static final byte[] READABLE_ENTRY_SEP

Constructor Detail

MessageStreams

public MessageStreams()

Method Detail

file

public static <T extends PMessage<T>,F extends PField> Stream<T> file(File file,
                                                                      Serializer serializer,
                                                                      PStructDescriptor<T,F> descriptor)
                                                               throws IOException

Read a file containing entries of a given type. Tries to detect the entry format of the file based on file magic. If not detected will try to use the default binary serializer format.

Type Parameters:

T - The message type.

F - The message field type.

Parameters:

file - The file to read.

serializer - The serializer to use.

descriptor - The descriptor of the entry type of the file.

Returns:

The stream that reads the file.

Throws:

IOException - when unable to open the stream.

resource

public static <T extends PMessage<T>,F extends PField> Stream<T> resource(String resource,
                                                                          Serializer serializer,
                                                                          PStructDescriptor<T,F> descriptor)
                                                                   throws IOException

Read a file containing entries of a given type. Tries to detect the entry format of the file based on file magic. If not detected will try to use the default binary serializer format.

Type Parameters:

T - The message type.

F - The message field type.

Parameters:

resource - The file to read.

serializer - The serializer to use.

descriptor - The descriptor of the entry type of the file.

Returns:

The stream that reads the file.

Throws:

IOException - when unable to open the stream.

stream

public static <T extends PMessage<T>,F extends PField> Stream<T> stream(InputStream in,
                                                                        Serializer serializer,
                                                                        PStructDescriptor<T,F> descriptor)
                                                                 throws IOException

Read a input stream containing entries of a given type. Tries to detect the entry format of the file based on file magic. If not detected will try to use the default binary serializer format.

Type Parameters:

T - The message type.

F - The message field type.

Parameters:

in - The input stream to read.

serializer - The serializer to use.

descriptor - The descriptor of the entry type of the file.

Returns:

The stream that reads the file.

Throws:

IOException - when unable to open the stream.