org.apache.nifi.components

Class AllowableValue

java.lang.Object

org.apache.nifi.components.AllowableValue

public class AllowableValue
extends Object

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

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) 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().
String	getDescription() Returns a description for this value, or null if no description was provided
String	getDisplayName() Returns a human-readable name for this AllowableValue
String	getValue() Returns the value of this AllowableValue
int	hashCode() Hash Code is based solely off of the value
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 -

AllowableValue

public AllowableValue(String value,
              String displayName)

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

Parameters:

value -

displayName -

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 -

displayName -

description -

Throws:

NullPointerException - if identifier or value is null

Method Detail

getValue

public String getValue()

Returns the value of this AllowableValue

Returns:

getDisplayName

public String getDisplayName()

Returns a human-readable name for this AllowableValue

Returns:

getDescription

public String getDescription()

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

Returns:

equals

public boolean equals(Object obj)

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().

Overrides:

equals in class Object

Returns:

hashCode

public int hashCode()

Hash Code is based solely off of the value

Overrides:

hashCode in class Object

Returns:

toString

public String toString()

Overrides:

toString in class Object