Package org.apache.nifi.registry

Class VariableDescriptor

java.lang.Object

org.apache.nifi.registry.VariableDescriptor

All Implemented Interfaces:

Comparable<VariableDescriptor>

public final class VariableDescriptor
extends Object
implements Comparable<VariableDescriptor>

An immutable object for holding information about a type of processor property.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	VariableDescriptor.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private final String	description	A brief description of the variable.
private final String	name	The name (or key) of the variable by which all access/lookups to the value will occur.
private final boolean	sensitive	indicates that the value for this variable should be considered sensitive and protected whenever stored or represented

Constructor Summary

Constructors

Modifier	Constructor	Description
	VariableDescriptor(String name)	Convenience constructor to create a descriptor based on name alone.
protected	VariableDescriptor(VariableDescriptor.Builder builder)

Method Summary

Modifier and Type	Method	Description
int	compareTo(VariableDescriptor o)
boolean	equals(Object other)
String	getDescription()
String	getName()
int	hashCode()
boolean	isSensitive()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

name

private final String name

The name (or key) of the variable by which all access/lookups to the value will occur. This is the mechanism of establishing identity and comparing equality.

description

private final String description

A brief description of the variable. This description is meant to be displayed to a user or simply provide a mechanism of documenting intent.

sensitive

private final boolean sensitive

indicates that the value for this variable should be considered sensitive and protected whenever stored or represented

Constructor Details

VariableDescriptor

public VariableDescriptor(String name)

Convenience constructor to create a descriptor based on name alone. To include additional parameters use Builder instead.

Parameters:

name - name used as unique identifier for this descriptor

VariableDescriptor

protected VariableDescriptor(VariableDescriptor.Builder builder)

Method Details

compareTo

public int compareTo(VariableDescriptor o)

Specified by:

compareTo in interface Comparable<VariableDescriptor>

getName

public String getName()

getDescription

public String getDescription()

isSensitive

public boolean isSensitive()

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object