io.cdap.wrangler.api

Interface Arguments

public interface Arguments

This class Arguments represents the wrapped tokens that are tokenized and parsed arguments provided to the Executor. This class Arguments includes methods for retrieving the value of the token provided the name for the token, number of tokens, support for checking if the named argument exists, type of token as specified by TokenType and helper method for constructing JsonElement object.

See Also:

UsageDefinition

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.

Method Detail

value

<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

Type Parameters:

T - type the token need to casted to.

Parameters:

name - of the token to be retrieved.

Returns:

object that extends Token.

size

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.

Returns:

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

contains

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.

Parameters:

name - associated with the token.

Returns:

true if argument with name name exists, false otherwise.

type

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.

Parameters:

name - associated with the token.

Returns:

TokenType associated with argument name, else null.

line

int line()

Returns the source line number these arguments were parsed from.

Returns:

the source line number.

column

int column()

Returns the source column number these arguments were parsed from.

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

Returns:

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

source

String source()

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

Returns:

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

toJson

com.google.gson.JsonElement toJson()

Returns JsonElement representation of this object.

Returns:

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