io.cdap.wrangler.registry

Class DirectiveInfo

java.lang.Object

io.cdap.wrangler.registry.DirectiveInfo

public final class DirectiveInfo
extends Object

This class DirectiveInfo contains information about each individual directive loaded. It also holds additional information like usage, description, scope,categories and the whether the directive is deprecated or not. Each instance of this class contains information for one directive.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DirectiveInfo.Scope Scope of the directive

Constructor Summary

Constructors

Constructor and Description
DirectiveInfo(DirectiveInfo.Scope scope, Class<?> directive)

Method Summary

Modifier and Type	Method and Description
String[]	categories()
UsageDefinition	definition()
boolean	deprecated()
String	description()
Directive	instance()
String	name()
DirectiveInfo.Scope	scope()
String	usage()

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectiveInfo

public DirectiveInfo(DirectiveInfo.Scope scope,
                     Class<?> directive)
              throws IllegalAccessException,
                     InstantiationException

Throws:

IllegalAccessException

InstantiationException

Method Detail

deprecated

public boolean deprecated()

scope

public DirectiveInfo.Scope scope()

name

public String name()

usage

public String usage()

description

public String description()

definition

public UsageDefinition definition()

categories

public String[] categories()

instance

public Directive instance()
                   throws IllegalAccessException,
                          InstantiationException

Throws:

IllegalAccessException

InstantiationException