edu.snu.coral.common.coder

Interface Coder<T>

Type Parameters:

T - element type.

All Superinterfaces:

Serializable

All Known Implementing Classes:

BeamCoder, BytesCoder, Coder.DummyCoder, SparkCoder

public interface Coder<T>
extends Serializable

A Coder<T> object encodes or decodes values of type T into byte streams.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Coder.DummyCoder Dummy coder implementation which is not supposed to be used.

Field Summary

Fields

Modifier and Type	Field and Description
static Coder	DUMMY_CODER Dummy coder.

Method Summary

Modifier and Type	Method and Description
T	decode(InputStream inStream) Decodes the a value from the given input stream.
void	encode(T element, OutputStream outStream) Encodes the given value onto the specified output stream.

Field Detail

DUMMY_CODER

static final Coder DUMMY_CODER

Dummy coder.

Method Detail

encode

void encode(T element,
            OutputStream outStream)
     throws IOException

Encodes the given value onto the specified output stream. It have to be able to encode the given stream consequently by calling this method repeatedly. Because the user can want to keep a single output stream and continuously concatenate elements, the output stream should not be closed.

Parameters:

element - the element to be encoded

outStream - the stream on which encoded bytes are written

Throws:

IOException - if fail to encode

decode

T decode(InputStream inStream)
  throws IOException

Decodes the a value from the given input stream. It have to be able to decode the given stream consequently by calling this method repeatedly. Because there are many elements in the input stream, the stream should not be closed.

Parameters:

inStream - the stream from which bytes are read

Returns:

the decoded element

Throws:

IOException - if fail to decode