Package org.apache.nifi.components
Class AllowableValue
java.lang.Object
org.apache.nifi.components.AllowableValue
- All Implemented Interfaces:
DescribedValue
Represents a valid value for a PropertyDescriptor
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionAllowableValue
(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 descriptionAllowableValue
(String value, String displayName, String description) Constructs a new AllowableValue with the given value, display name, and description -
Method Summary
-
Field Details
-
value
-
displayName
-
description
-
-
Constructor Details
-
AllowableValue
Constructs a new AllowableValue with the given value and and the same display name and no description.- Parameters:
value
- that is allowed
-
AllowableValue
Constructs a new AllowableValue with the given value and display name and no description- Parameters:
value
- that is alloweddisplayName
- to display for the value- Throws:
NullPointerException
- if either argument is null
-
AllowableValue
Constructs a new AllowableValue with the given value, display name, and description- Parameters:
value
- that is validdisplayName
- to show for the valuedescription
- of the value- Throws:
NullPointerException
- if identifier or value is null
-
-
Method Details
-
getValue
- Specified by:
getValue
in interfaceDescribedValue
- Returns:
- the value of this AllowableValue
-
getDisplayName
- Specified by:
getDisplayName
in interfaceDescribedValue
- Returns:
- a human-readable name for this AllowableValue
-
getDescription
- Specified by:
getDescription
in interfaceDescribedValue
- Returns:
- a description for this value, or
null
if no description was provided
-
equals
- Overrides:
equals
in classObject
- Returns:
- true if
this
is equal toobj
ofobj
is the same object asthis
or ifobj
is an instance ofAllowableValue
and both have the same value, or ifobj
is a String and is equal tothis.getValue()
.
-
hashCode
public int hashCode() -
toString
-