Module org.apache.nifi

Package 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	Description
static class	ParameterDescriptor.Builder

Method Summary

Modifier and Type	Method	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

Method Details

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