io.cdap.wrangler.api.parser

Class UsageDefinition.Builder

java.lang.Object

io.cdap.wrangler.api.parser.UsageDefinition.Builder

Enclosing class:

UsageDefinition

public static final class UsageDefinition.Builder
extends Object

This inner builder class provides a way to create UsageDefinition object. It exposes different methods that allow users to configure the TokenDefinition for each token used within the usage of a directive.

Constructor Summary

Constructors

Constructor and Description
Builder(String directive)

Method Summary

Modifier and Type	Method and Description
UsageDefinition	build()
void	define(String name, TokenType type) This method provides a way to set the name and the type of token, while defaulting the label to 'null' and setting the optional to FALSE.
void	define(String name, TokenType type, boolean optional) Method allows users to specify a field as optional in combination to the name of the token and the type of token.
void	define(String name, TokenType type, String label) Allows users to define a token with a name, type of the token and additional optional for the label that is used during creation of the usage for the directive.
void	define(String name, TokenType type, String label, boolean optional) Method allows users to specify a field as optional in combination to the name of the token, the type of token and also the ability to specify a label for the usage.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String directive)

Method Detail

define

public void define(String name,
                   TokenType type)

This method provides a way to set the name and the type of token, while defaulting the label to 'null' and setting the optional to FALSE.

Parameters:

name - of the token in the definition of a directive.

type - of the token to be extracted.

define

public void define(String name,
                   TokenType type,
                   String label)

Allows users to define a token with a name, type of the token and additional optional for the label that is used during creation of the usage for the directive.

Parameters:

name - of the token in the definition of a directive.

type - of the token to be extracted.

label - label that modifies the usage for this field.

define

public void define(String name,
                   TokenType type,
                   boolean optional)

Method allows users to specify a field as optional in combination to the name of the token and the type of token.

Parameters:

name - of the token in the definition of a directive.

type - of the token to be extracted.

optional - Optional#TRUE if token is optional, else Optional#FALSE.

define

public void define(String name,
                   TokenType type,
                   String label,
                   boolean optional)

Method allows users to specify a field as optional in combination to the name of the token, the type of token and also the ability to specify a label for the usage.

Parameters:

name - of the token in the definition of a directive.

type - of the token to be extracted.

label - label that modifies the usage for this field.

optional - Optional#TRUE if token is optional, else Optional#FALSE.

build

public UsageDefinition build()

Returns:

a instance of UsageDefinition object.