io.cdap.wrangler.api

Class RecipeSymbol.Builder

java.lang.Object

io.cdap.wrangler.api.RecipeSymbol.Builder

Enclosing class:

RecipeSymbol

public static final class RecipeSymbol.Builder
extends Object

This inner class provides a builder pattern for building the RecipeSymbol object. In order to create the this builder, one has to use the static method defined in RecipeSymbol. Following is an example of how this can be done. RecipeSymbol.Builder builder = RecipeSymbol.builder(); builder.createTokenGroup(...); builder.addToken(...); builder.addVersion(...); builder.addLoadableDirective(...); RecipeSymbol compiled = builder.build();

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
void	addLoadableDirective(String directive) A Recipe can specify the pragma instructions for loading the directives dynamically.
void	addToken(Token token) This method provides a way to add a Token to the TokenGroup.
void	addVersion(String version) Recipe can specify the version of the grammar.
RecipeSymbol	build() Returns a fully constructed and valid RecipeSymbol object.
void	createTokenGroup(SourceInfo info) TokenGroup is created for each directive in the recipe.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

createTokenGroup

public void createTokenGroup(SourceInfo info)

TokenGroup is created for each directive in the recipe. This method creates a new TokenGroup by passing the SourceInfo, which represents the information of the source parsed.

Parameters:

info - about the source directive being parsed.

addToken

public void addToken(Token token)

This method provides a way to add a Token to the TokenGroup.

Parameters:

token - to be added to the token group.

addVersion

public void addVersion(String version)

Recipe can specify the version of the grammar. This method allows one to extract and add the version to the RecipeSymbol.

Parameters:

version - of the recipe grammar being used.

addLoadableDirective

public void addLoadableDirective(String directive)

A Recipe can specify the pragma instructions for loading the directives dynamically. This method allows adding the new directive to be loaded as it's parsing through the call graph.

Parameters:

directive - to be loaded dynamically.

build

public RecipeSymbol build()

Returns a fully constructed and valid RecipeSymbol object.

Returns:

An instance of RecipeSymbol