io.cdap.wrangler.parser

Class MapArguments

java.lang.Object

io.cdap.wrangler.parser.MapArguments

All Implemented Interfaces:

Arguments

public class MapArguments
extends Object
implements Arguments

Class description here.

Constructor Summary

Constructors

Constructor and Description
MapArguments(UsageDefinition definition, TokenGroup group)

Method Summary

Modifier and Type	Method and Description
int	column() Returns the source column number these arguments were parsed from.
boolean	contains(String name) This method checks if there exists a token named name registered with this object.
int	line() Returns the source line number these arguments were parsed from.
int	size() Returns the number of tokens that are mapped to arguments.
String	source() This method returns the original source line of the directive as specified the user.
com.google.gson.JsonElement	toJson() Returns JsonElement representation of this object.
TokenType	type(String name) Each token is defined as one of the types defined in the class TokenType.
<T extends Token> T	value(String name) This method returns the token value based on the name specified in the argument.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapArguments

public MapArguments(UsageDefinition definition,
                    TokenGroup group)
             throws DirectiveParseException

Throws:

DirectiveParseException

Method Detail

size

public int size()

Returns the number of tokens that are mapped to arguments.

The optional arguments specified during the UsageDefinition are not included in the size if they are not present in the tokens parsed.

Specified by:

size in interface Arguments

Returns:

number of tokens parsed, excluding optional tokens if not present.

contains

public boolean contains(String name)

This method checks if there exists a token named name registered with this object. The name is expected to the same as specified in the UsageDefinition. There are two reason why the name might not exists in this object :

• When an token is defined to be optional, the user might not have specified the token, hence the token would not exist in the argument.
• User has specified invalid name.

Specified by:

contains in interface Arguments

Parameters:

name - associated with the token.

Returns:

true if argument with name name exists, false otherwise.

value

public <T extends Token> T value(String name)

This method returns the token value based on the name specified in the argument. This method will attempt to convert the token into the expected return type T.

If the name doesn't exist in this object, then this method is expected to return null

Specified by:

value in interface Arguments

Parameters:

name - of the token to be retrieved.

Returns:

object that extends Token.

type

public TokenType type(String name)

Each token is defined as one of the types defined in the class TokenType. When the directive is parsed into token, the type of the token is passed through.

Specified by:

type in interface Arguments

Parameters:

name - associated with the token.

Returns:

TokenType associated with argument name, else null.

line

public int line()

Returns the source line number these arguments were parsed from.

Specified by:

line in interface Arguments

Returns:

the source line number.

column

public int column()

Returns the source column number these arguments were parsed from.

It takes the start position of the directive as the column number.

Specified by:

column in interface Arguments

Returns:

the start of the column number for the start of the directive these arguments contain.

source

public String source()

This method returns the original source line of the directive as specified the user. It returns the String representation of the directive.

Specified by:

source in interface Arguments

Returns:

String object representing the original directive as specified by the user.

toJson

public com.google.gson.JsonElement toJson()

Returns JsonElement representation of this object.

Specified by:

toJson in interface Arguments

Returns:

an instance of JsonElementobject representing all the named tokens held within this object.