org.apache.nifi.components

Class AllowableValue

java.lang.Object

org.apache.nifi.components.AllowableValue

All Implemented Interfaces:

DescribedValue

public class AllowableValue
extends Object
implements DescribedValue

Represents a valid value for a PropertyDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
private String	description
private String	displayName
private String	value

Constructor Summary

Constructors

Constructor and Description
AllowableValue(String value) Constructs a new AllowableValue with the given value and and the same display name and no description.
AllowableValue(String value, String displayName) Constructs a new AllowableValue with the given value and display name and no description
AllowableValue(String value, String displayName, String description) Constructs a new AllowableValue with the given value, display name, and description

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDescription()
String	getDisplayName()
String	getValue()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

value

private final String value

displayName

private final String displayName

description

private final String description

Constructor Detail

AllowableValue

public AllowableValue(String value)

Constructs a new AllowableValue with the given value and and the same display name and no description.

Parameters:

value - that is allowed

AllowableValue

public AllowableValue(String value,
                      String displayName)

Constructs a new AllowableValue with the given value and display name and no description

Parameters:

value - that is allowed

displayName - to display for the value

Throws:

NullPointerException - if either argument is null

AllowableValue

public AllowableValue(String value,
                      String displayName,
                      String description)

Constructs a new AllowableValue with the given value, display name, and description

Parameters:

value - that is valid

displayName - to show for the value

description - of the value

Throws:

NullPointerException - if identifier or value is null

Method Detail

getValue

public String getValue()

Specified by:

getValue in interface DescribedValue

Returns:

the value of this AllowableValue

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface DescribedValue

Returns:

a human-readable name for this AllowableValue

getDescription

public String getDescription()

Specified by:

getDescription in interface DescribedValue

Returns:

a description for this value, or null if no description was provided

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Returns:

true if this is equal to obj of obj is the same object as this or if obj is an instance of AllowableValue and both have the same value, or if obj is a String and is equal to this.getValue().

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

based solely off of the value

toString

public String toString()

Overrides:

toString in class Object