io.cdap.cdap.api.data.batch

Class Splits

java.lang.Object

io.cdap.cdap.api.data.batch.Splits

public final class Splits
extends Object

Utility class to serialize and deserialize Split.

Method Summary

Modifier and Type	Method and Description
static <T extends Collection<? super Split>> T	decode(String encoded, T splits, ClassLoader classLoader) Deserialize a list of Splits encoded by the encode(Iterable) method
static Split	deserialize(DataInput in, ClassLoader classLoader) Deserialize a Split that was written by the serialize(Split, DataOutput) method using a provided ClassLoader to load the Split class.
static String	encode(Iterable<? extends Split> splits) Serialize a list of Splitss to a String.
static void	serialize(Split split, DataOutput out) Serialize a Split instance.

Methods inherited from class java.lang.Object

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

Method Detail

encode

public static String encode(Iterable<? extends Split> splits)
                     throws IOException

Serialize a list of Splitss to a String.

Parameters:

splits - the list of splits to serialize

Returns:

a String representation of the splits.

Throws:

IOException - if failed to serialize

decode

public static <T extends Collection<? super Split>> T decode(String encoded,
                                                             T splits,
                                                             ClassLoader classLoader)
                                                      throws IOException,
                                                             ClassNotFoundException

Deserialize a list of Splits encoded by the encode(Iterable) method

Type Parameters:

T - type of the Collection

Parameters:

encoded - the encoded string produced by the encode(Iterable) method

splits - a Collection for storing the decoded splits

classLoader - the ClassLoader for loading the Split class

Returns:

the same Collection passed in the arguments

Throws:

IOException - if failed to deserialize

ClassNotFoundException - if failed to load the Split class.

serialize

public static void serialize(Split split,
                             DataOutput out)
                      throws IOException

Serialize a Split instance.

Parameters:

split - the Split to serialize

out - the DataOutput that the serialized data is writing to

Throws:

IOException - if failed to serialize

deserialize

public static Split deserialize(DataInput in,
                                ClassLoader classLoader)
                         throws IOException,
                                ClassNotFoundException

Deserialize a Split that was written by the serialize(Split, DataOutput) method using a provided ClassLoader to load the Split class.

Parameters:

in - the DataInput for reading the serialized data

classLoader - the ClassLoader for loading the actual Split class

Returns:

a Split instance

Throws:

IOException - if failed to deserialize

ClassNotFoundException - if failed to load the split class as indicated by the encoded string