io.cdap.wrangler.parser

Class UsageRegistry

java.lang.Object

io.cdap.wrangler.parser.UsageRegistry

All Implemented Interfaces:

Serializable

public final class UsageRegistry
extends Object
implements Serializable

Registry of directive usages managed through this class.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	UsageRegistry.UsageEntry A UsageRegistry.UsageEntry defines the information about the directives that are available.

Constructor Summary

Constructors

Constructor and Description
UsageRegistry()

Method Summary

Modifier and Type	Method and Description
void	addUsage(Class<? extends Executor> classz) Adds a class that extends from AbstractDirective to usage registry.
List<UsageRegistry.UsageEntry>	getAll()
String	getDescription(String directive) Gets the description of a directive.
String	getUsage(String directive) Gets the usage of a directive.

Methods inherited from class java.lang.Object

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

Constructor Detail

UsageRegistry

public UsageRegistry()

Method Detail

addUsage

public void addUsage(Class<? extends Executor> classz)

Adds a class that extends from AbstractDirective to usage registry.

Parameters:

classz - representing an AbstractDirective implementation.

getUsage

public String getUsage(String directive)

Gets the usage of a directive.

Parameters:

directive - for which usage is returned.

Returns:

null if not found, else the usage.

getDescription

public String getDescription(String directive)

Gets the description of a directive.

Parameters:

directive - for which usage is returned.

Returns:

null if not found, else the description of usage.

getAll

public List<UsageRegistry.UsageEntry> getAll()

Returns:

A map of directive to UsageRegistry.UsageEntry.