io.cdap.wrangler.api

Class RecipeSymbol

java.lang.Object

io.cdap.wrangler.api.RecipeSymbol

@PublicEvolving
public final class RecipeSymbol
extends Object

This object RecipeSymbol stores information about all the TokenGroup ( TokenGroup represents a collection of tokens generated from parsing a single directive). The object also contains information about the directives (or plugins) that need to be loaded at the startup time.

This class provides some useful methods for accessing the list of directives or plugins that need to be loaded, the token groups for all the directives tokenized and parsed.

This class exposes a builder pattern for constructing the object. in the RecipeVisitor. The RecipeVisitor constructs RecipeSymbol using the RecipeSymbol.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecipeSymbol.Builder This inner class provides a builder pattern for building the RecipeSymbol object.

Method Summary

Modifier and Type	Method and Description
static RecipeSymbol.Builder	builder() Static method for creating an instance of the RecipeSymbol.Builder.
Set<String>	getLoadableDirectives() Returns a set of dynamically loaded directives as plugins.
String	getVersion() Returns the version of the grammar as specified in the recipe.
Iterator<TokenGroup>	iterator() Returns an iterator to the list of token groups maintained by this object.
int	size() Returns number of groups tokenized and parsed.
com.google.gson.JsonElement	toJson() This method toJson returns the JsonElement object representation of this object.

Methods inherited from class java.lang.Object

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

Method Detail

getLoadableDirectives

public Set<String> getLoadableDirectives()

Returns a set of dynamically loaded directives as plugins. These are the set of plugins or directives that are in the recipe, but are provided as the user plugins.

If there are no directives specified in the recipe, then there would be no plugins to be loaded.

Returns:

An empty set if there are not directives to be loaded dynamically, else the list of directives as specified in the recipe.

getVersion

public String getVersion()

Returns the version of the grammar as specified in the recipe. The version is the one extracted from Pragma. It's specified as follows #pragma version 2.0;

Returns:

version of the grammar used in the recipe.

size

public int size()

Returns number of groups tokenized and parsed. The number returned will less than or equal to the number of directives specified in the recipe.

Fewer than number of directives is because of the '#pragma' directives

Returns:

iterator

public Iterator<TokenGroup> iterator()

Returns an iterator to the list of token groups maintained by this object.

Returns:

iterator to the list of tokens maintained.

builder

public static RecipeSymbol.Builder builder()

Static method for creating an instance of the RecipeSymbol.Builder.

Returns:

a instance of builder.

toJson

public com.google.gson.JsonElement toJson()

This method toJson returns the JsonElement object representation of this object.

Returns:

An instance of JsonElement representing this object.