io.cdap.wrangler.api.parser

Class TokenDefinition

java.lang.Object

io.cdap.wrangler.api.parser.TokenDefinition

All Implemented Interfaces:

Serializable

@PublicEvolving
public final class TokenDefinition
extends Object
implements Serializable

The TokenDefinition class represents a definition of token as specified by the user while defining a directive usage. All definitions of a token are represented by a instance of this class. The definition are constant (immutable) and they cannot be changed once defined. For example : TokenDefinition token = new TokenDefintion("column", TokenType.COLUMN_NAME, null, 0, Optional.FALSE);

The class TokenDefinition includes methods for retrieveing different members of like name of the token, type of the token, label associated with token, whether it's optional or not and the ordinal number of the token in the TokenGroup.

As this class is immutable, the constructor requires all the member variables to be presnted for an instance of this object to be created.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TokenDefinition(String name, TokenType type, String label, int ordinal, boolean optional)

Method Summary

Modifier and Type	Method and Description
String	label()
String	name()
boolean	optional()
int	ordinal()
TokenType	type()

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenDefinition

public TokenDefinition(String name,
                       TokenType type,
                       String label,
                       int ordinal,
                       boolean optional)

Method Detail

label

public String label()

Returns:

Label associated with the token. Label provides a way to override the usage description for this TokenDefinition. If a label is not provided, then this return null.

ordinal

public int ordinal()

Returns:

Returns the oridinal number of this TokenDefinition within the TokenGroup,

optional

public boolean optional()

Returns:

true, if this TokenDefinition is optional, false otherwise.

name

public String name()

Returns:

Name of this TokenDefinition

type

public TokenType type()

Returns:

Returns the type of this TokenDefinition.