Module org.apache.nifi
Package 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 component property.

  • Field Details

  • Constructor Details

  • Method Details

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

    • getExpressionLanguageScope

      public ExpressionLanguageScope getExpressionLanguageScope()

    • isDynamicClasspathModifier

      public boolean isDynamicClasspathModifier()

    • getControllerServiceDefinition

      public Class<? extends ControllerService> getControllerServiceDefinition()

    • getValidators

      public List<Validator> getValidators()

    • getAllowableValues

      public List<AllowableValue> getAllowableValues()

    • getDependencies

      public Set<PropertyDependency> getDependencies()

    • getResourceDefinition

      public ResourceDefinition getResourceDefinition()

    • 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