co.cask.cdap.common.io

Interface Encoder

All Known Implementing Classes:

JsonEncoder

public interface Encoder

Interface for encoding data.

Method Summary

Modifier and Type	Method and Description
Encoder	writeBool(boolean b) Writes out a boolean value.
Encoder	writeBytes(byte[] bytes) Writes out a byte array.
Encoder	writeBytes(byte[] bytes, int off, int len) Writes out a byte array.
Encoder	writeBytes(ByteBuffer bytes) Writes out the remaining bytes in ByteBuffer.
Encoder	writeDouble(double d) Writes out a double value.
Encoder	writeFloat(float f) Writes out a float value.
Encoder	writeInt(int i) Writes out a int value.
Encoder	writeLong(long l) Writes out a long value.
Encoder	writeNull() Writes out a null value.
Encoder	writeString(String s) Writes out a string value.

Method Detail

writeNull

Encoder writeNull()
           throws IOException

Writes out a null value.

Returns:

this Encoder

Throws:

IOException - if failed to encode

writeBool

Encoder writeBool(boolean b)
           throws IOException

Writes out a boolean value.

Parameters:

b - the value to write

Returns:

this Encoder

Throws:

IOException - if failed to encode

writeInt

Encoder writeInt(int i)
          throws IOException

Writes out a int value.

Parameters:

i - the value to write

Returns:

this Encoder

Throws:

IOException - if failed to encode

writeLong

Encoder writeLong(long l)
           throws IOException

Writes out a long value.

Parameters:

l - the value to write

Returns:

this Encoder

Throws:

IOException - if failed to encode

writeFloat

Encoder writeFloat(float f)
            throws IOException

Writes out a float value.

Parameters:

f - the value to write

Returns:

this Encoder

Throws:

IOException - if failed to encode

writeDouble

Encoder writeDouble(double d)
             throws IOException

Writes out a double value.

Parameters:

d - the value to write

Returns:

this Encoder

Throws:

IOException - if failed to encode

writeString

Encoder writeString(String s)
             throws IOException

Writes out a string value.

Parameters:

s - the value to write

Returns:

this Encoder

Throws:

IOException - if failed to encode

writeBytes

Encoder writeBytes(byte[] bytes)
            throws IOException

Writes out a byte array.

Parameters:

bytes - the value to write

Returns:

this Encoder

Throws:

IOException - if failed to encode

writeBytes

Encoder writeBytes(byte[] bytes,
                   int off,
                   int len)
            throws IOException

Writes out a byte array.

Parameters:

bytes - the value to write

off - the starting offset in the byte array to write

len - number of bytes to write, starting from the given offset

Returns:

this Encoder

Throws:

IOException - if failed to encode

writeBytes

Encoder writeBytes(ByteBuffer bytes)
            throws IOException

Writes out the remaining bytes in ByteBuffer. The given ByteBuffer is untounch after this method is returned (i.e. same position and limit).

Parameters:

bytes - bytes to write

Returns:

this Encoder

Throws:

IOException - if failed to encode