edu.snu.coral.common.coder

Class BytesCoder

java.lang.Object

edu.snu.coral.common.coder.BytesCoder

All Implemented Interfaces:

Coder<byte[]>, Serializable

public final class BytesCoder
extends Object
implements Coder<byte[]>

A Coder which is used for an array of bytes.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface edu.snu.coral.common.coder.Coder

Coder.DummyCoder

Field Summary

Fields inherited from interface edu.snu.coral.common.coder.Coder

DUMMY_CODER

Constructor Summary

Constructors

Constructor and Description
BytesCoder() Constructor.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BytesCoder

public BytesCoder()

Constructor.

Method Detail

encode

public void encode(byte[] value,
                   OutputStream outStream)
            throws IOException

Description copied from interface: Coder

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.

Specified by:

encode in interface Coder<byte[]>

Parameters:

value - the element to be encoded

outStream - the stream on which encoded bytes are written

Throws:

IOException - if fail to encode

decode

public byte[] decode(InputStream inStream)
              throws IOException

Description copied from interface: Coder

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.

Specified by:

decode in interface Coder<byte[]>

Parameters:

inStream - the stream from which bytes are read

Returns:

the decoded element

Throws:

IOException - if fail to decode