io.cdap.cdap.api.dataset.lib

Class Partitioning.Builder

java.lang.Object

io.cdap.cdap.api.dataset.lib.Partitioning.Builder

Enclosing class:

Partitioning

public static class Partitioning.Builder
extends Object

A builder for partitioning objects.

Method Summary

Modifier and Type	Method and Description
Partitioning.Builder	addField(String name, Partitioning.FieldType type) Add a field with a given name and type.
Partitioning.Builder	addIntField(String name) Add field of type INT.
Partitioning.Builder	addLongField(String name) Add field of type LONG.
Partitioning.Builder	addStringField(String name) Add field of type STRING.
Partitioning	build() Create the partitioning.

Methods inherited from class java.lang.Object

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

Method Detail

addField

public Partitioning.Builder addField(@Nonnull
                                     String name,
                                     @Nonnull
                                     Partitioning.FieldType type)

Add a field with a given name and type.

Parameters:

name - the field name

type - the type of the field

Throws:

IllegalArgumentException - if the field name is null, empty, or already exists, or if the type is null.

addStringField

public Partitioning.Builder addStringField(String name)

Add field of type STRING.

Parameters:

name - the field name

Throws:

IllegalArgumentException - if the field name is null, empty, or already exists.

addIntField

public Partitioning.Builder addIntField(String name)

Add field of type INT.

Parameters:

name - the field name

Throws:

IllegalArgumentException - if the field name is null, empty, or already exists.

addLongField

public Partitioning.Builder addLongField(String name)

Add field of type LONG.

Parameters:

name - the field name

Throws:

IllegalArgumentException - if the field name is null, empty, or already exists.

build

public Partitioning build()

Create the partitioning.

Throws:

IllegalStateException - if no fields have been added