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

    • 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

    • expressionLanguageScope

      private final ExpressionLanguageScope expressionLanguageScope
      indicates whether or nor this property will evaluate expression language against the flow file attributes

    • dynamicallyModifiesClasspath

      private final boolean dynamicallyModifiesClasspath
      indicates whether or not this property represents resources that should be added to the classpath and used for loading native libraries for this instance of the component

    • 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.

    • dependencies

      private final Set<PropertyDependency> dependencies
      The list of dependencies that this property has on other properties

    • resourceDefinition

      private final ResourceDefinition resourceDefinition
      The definition of the resource(s) that this property references

  • 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