org.apache.nifi.components

Class PropertyDescriptor

java.lang.Object

org.apache.nifi.components.PropertyDescriptor

All Implemented Interfaces:

Comparable<PropertyDescriptor>

public final class PropertyDescriptor
extends Object
implements Comparable<PropertyDescriptor>

An immutable object for holding information about a type of processor property.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PropertyDescriptor.Builder
private static class	PropertyDescriptor.ConstrainedSetValidator

Field Summary

Fields

Modifier and Type	Field and Description
private List<AllowableValue>	allowableValues The allowable values for this property.
private Class<? extends ControllerService>	controllerServiceDefinition the interface of the ControllerService that this Property refers to; will be null if not identifying a ControllerService.
private String	defaultValue The default value for this property
private String	description And explanation of the meaning of the given property.
private String	displayName The name that should be displayed to user when referencing this property
private boolean	dynamic indicates whether this property well-known for this processor or is user-defined
private boolean	expressionLanguageSupported indicates whether or not this property supports the Attribute Expression Language
private String	name The proper name for the property.
static PropertyDescriptor	NULL_DESCRIPTOR
private boolean	required Determines whether the property is required for this processor
private boolean	sensitive indicates that the value for this property should be considered sensitive and protected whenever stored or represented
private List<Validator>	validators The validators that should be used whenever an attempt is made to set this property value.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PropertyDescriptor(PropertyDescriptor.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(PropertyDescriptor o)
boolean	equals(Object other)
List<AllowableValue>	getAllowableValues()
Class<? extends ControllerService>	getControllerServiceDefinition()
String	getDefaultValue()
String	getDescription()
String	getDisplayName()
String	getName()
List<Validator>	getValidators()
int	hashCode()
boolean	isDynamic()
boolean	isExpressionLanguageSupported()
boolean	isRequired()
boolean	isSensitive()
String	toString()
ValidationResult	validate(String input, ValidationContext context) Validates the given input against this property descriptor's validator.

Methods inherited from class java.lang.Object

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

Field Detail

NULL_DESCRIPTOR

public static final PropertyDescriptor NULL_DESCRIPTOR

name

private final String name

The proper name for the property. This is the primary mechanism of comparing equality.

displayName

private final String displayName

The name that should be displayed to user when referencing this property

description

private final String description

And explanation of the meaning of the given property. This description is meant to be displayed to a user or simply provide a mechanism of documenting intent.

defaultValue

private final String defaultValue

The default value for this property

allowableValues

private final List<AllowableValue> allowableValues

The allowable values for this property. If empty then the allowable values are not constrained

required

private final boolean required

Determines whether the property is required for this processor

sensitive

private final boolean sensitive

indicates that the value for this property should be considered sensitive and protected whenever stored or represented

dynamic

private final boolean dynamic

indicates whether this property well-known for this processor or is user-defined

expressionLanguageSupported

private final boolean expressionLanguageSupported

indicates whether or not this property supports the Attribute Expression Language

controllerServiceDefinition

private final Class<? extends ControllerService> controllerServiceDefinition

the interface of the ControllerService that this Property refers to; will be null if not identifying a ControllerService.

validators

private final List<Validator> validators

The validators that should be used whenever an attempt is made to set this property value. Any allowable values specified will be checked first and any validators specified will be ignored.

Constructor Detail

PropertyDescriptor

protected PropertyDescriptor(PropertyDescriptor.Builder builder)

Method Detail

compareTo

public int compareTo(PropertyDescriptor o)

Specified by:

compareTo in interface Comparable<PropertyDescriptor>

validate

public ValidationResult validate(String input,
                        ValidationContext context)

Validates the given input against this property descriptor's validator. If this descriptor has a set of allowable values then the given value is only checked against the allowable values.

Parameters:

input - the value to validate

context - the context of validation

Returns:

the result of validating the input

getDisplayName

public String getDisplayName()

getName

public String getName()

getDescription

public String getDescription()

getDefaultValue

public String getDefaultValue()

isRequired

public boolean isRequired()

isSensitive

public boolean isSensitive()

isDynamic

public boolean isDynamic()

isExpressionLanguageSupported

public boolean isExpressionLanguageSupported()

getControllerServiceDefinition

public Class<? extends ControllerService> getControllerServiceDefinition()

getValidators

public List<Validator> getValidators()

getAllowableValues

public List<AllowableValue> getAllowableValues()

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object