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 and Description
static class	VariableDescriptor.Builder

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and 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 and 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 Detail

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 Detail

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 Detail

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