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.

Since:

3.0

See Also:

SystemDirectiveRegistry, UserDirectiveRegistry, CompositeDirectiveRegistry

Method Summary

Modifier and Type	Method and Description
String[]	categories()
UsageDefinition	definition()
boolean	deprecated()
String	description()
static DirectiveInfo	fromSystem(Class<? extends Directive> cls) Creates a DirectiveInfo of the given class coming from the DirectiveScope.SYSTEM scope.
static DirectiveInfo	fromUser(Class<? extends Directive> cls, ArtifactId artifactId) Creates a DirectiveInfo of the given class coming from the DirectiveScope.USER scope.
DirectiveClass	getDirectiveClass()
Directive	instance() Creates a new instance of Directive.
String	name()
DirectiveScope	scope()
String	usage()

Methods inherited from class java.lang.Object

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

Method Detail

fromSystem

public static DirectiveInfo fromSystem(Class<? extends Directive> cls)
                                throws InstantiationException,
                                       IllegalAccessException

Creates a DirectiveInfo of the given class coming from the DirectiveScope.SYSTEM scope.

Throws:

InstantiationException

IllegalAccessException

fromUser

public static DirectiveInfo fromUser(Class<? extends Directive> cls,
                                     @Nullable
                                     ArtifactId artifactId)
                              throws InstantiationException,
                                     IllegalAccessException

Creates a DirectiveInfo of the given class coming from the DirectiveScope.USER scope.

Throws:

InstantiationException

IllegalAccessException

getDirectiveClass

public DirectiveClass getDirectiveClass()

Returns:

a DirectiveClass which contains the class information of this directive.

deprecated

public boolean deprecated()

Returns:

a Boolean type that indicates if Directive has been deprecated or not.

scope

public DirectiveScope scope()

Returns:

a Scope type specifying either USER or SYSTEM scope the directive is deployed in.

name

public String name()

Returns:

a String type specifying the name of the directive.

usage

public String usage()

Returns:

a String type containing the usage information of the directive.

description

public String description()

Returns:

a String type providing the description for a directive.

definition

public UsageDefinition definition()

Returns:

a String type specifying the definition information of directive.

categories

public String[] categories()

Returns:

a String array providing the categories the directive is associated with.

instance

public Directive instance()
                   throws IllegalAccessException,
                          InstantiationException

Creates a new instance of Directive.

Returns:

a Directive instance.

Throws:

IllegalAccessException - thrown when an application tries to reflectively create an instance

InstantiationException - Thrown when an application tries to create an instance of a class using the newInstance method in class Class