org.apache.drill.exec.server.options

Class OptionValidator.OptionDescription

java.lang.Object

org.apache.drill.exec.server.options.OptionValidator.OptionDescription

Enclosing class:

OptionValidator

public static class OptionValidator.OptionDescription
extends Object

Constructor Summary

Constructors

Constructor and Description
OptionDescription(String description) Constructor for option's description
OptionDescription(String description, String shortDescription) Constructor for option's description

Method Summary

Modifier and Type	Method and Description
String	getDescription() Get verbose description
String	getShortDescription() Get short description (typically for system tables)
boolean	hasShortDescription() Check for explicit short description

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionDescription

public OptionDescription(String description)

Constructor for option's description

Parameters:

description - verbose format

OptionDescription

public OptionDescription(String description,
                         String shortDescription)

Constructor for option's description

Parameters:

description - verbose format

shortDescription - short format

Method Detail

getDescription

public String getDescription()

Get verbose description

Returns:

verbose description

getShortDescription

public String getShortDescription()

Get short description (typically for system tables)

Returns:

short description

hasShortDescription

public boolean hasShortDescription()

Check for explicit short description

Returns:

true if a short description explicitly exists