io.cdap.wrangler.api

Class Optional

java.lang.Object

io.cdap.wrangler.api.Optional

@Public
public final class Optional
extends Object

This class Optional is a helper class used in specifying whether a argument for the directive is optional or not.

This class is used when you are defining the usage for a directive argument. Following is an example :

UsageDefinition.Builder builder = UsageDefinition.builder(NAME); builder.define("regex", TokenType.TEXT, Optional.TRUE); return builder.build();

By default, the option is FALSE

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	FALSE When an argument is non optional, FALSE is specified.
static boolean	TRUE When an argument is optional, TRUE is specified.

Constructor Summary

Constructors

Constructor and Description
Optional()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

TRUE

public static final boolean TRUE

When an argument is optional, TRUE is specified.

See Also:

Constant Field Values

FALSE

public static final boolean FALSE

When an argument is non optional, FALSE is specified. The default behavior is false.

See Also:

Constant Field Values

Constructor Detail

Optional

public Optional()