org.apache.nifi.parameter

Class ParameterDescriptor

java.lang.Object

org.apache.nifi.parameter.ParameterDescriptor

public class ParameterDescriptor
extends Object

An immutable class that holds information about a Parameter. Parameters are constructed through use of the ParameterDescriptor.Builder class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParameterDescriptor.Builder

Field Summary

Fields

Modifier and Type	Field and Description
private String	description
private String	name
private boolean	sensitive

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ParameterDescriptor(ParameterDescriptor.Builder builder)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

name

private final String name

description

private final String description

sensitive

private final boolean sensitive

Constructor Detail

ParameterDescriptor

private ParameterDescriptor(ParameterDescriptor.Builder builder)

Method Detail

getName

public String getName()

Returns:

the name of the parameter

getDescription

public String getDescription()

Returns:

a description of the parameter

isSensitive

public boolean isSensitive()

Returns:

whether or not the parameter is considered sensitive.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object