public final class PropertyDescriptor extends Object implements Comparable<PropertyDescriptor>
Modifier and Type | Class and Description |
---|---|
static class |
PropertyDescriptor.Builder |
private static class |
PropertyDescriptor.ConstrainedSetValidator |
private static class |
PropertyDescriptor.ResourceDefinitionValidator |
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 Set<PropertyDependency> |
dependencies
The list of dependencies that this property has on other properties
|
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 |
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
|
private ExpressionLanguageScope |
expressionLanguageScope
indicates whether or nor this property will evaluate expression language
against the flow file attributes
|
private boolean |
expressionLanguageSupported
Deprecated.
|
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 ResourceDefinition |
resourceDefinition
The definition of the resource(s) that this property references
|
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.
|
Modifier | Constructor and Description |
---|---|
protected |
PropertyDescriptor(PropertyDescriptor.Builder builder) |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(PropertyDescriptor o) |
boolean |
equals(Object other) |
List<AllowableValue> |
getAllowableValues() |
Class<? extends ControllerService> |
getControllerServiceDefinition() |
String |
getDefaultValue() |
Set<PropertyDependency> |
getDependencies() |
String |
getDescription() |
String |
getDisplayName() |
ExpressionLanguageScope |
getExpressionLanguageScope() |
String |
getName() |
ResourceDefinition |
getResourceDefinition() |
List<Validator> |
getValidators() |
int |
hashCode() |
boolean |
isDynamic() |
boolean |
isDynamicClasspathModifier() |
boolean |
isExpressionLanguageSupported() |
boolean |
isRequired() |
boolean |
isSensitive() |
String |
toString() |
ValidationResult |
validate(String input,
ValidationContext context)
Validates the given input against this property descriptor's validator.
|
public static final PropertyDescriptor NULL_DESCRIPTOR
private final String name
private final String displayName
private final String description
private final String defaultValue
private final List<AllowableValue> allowableValues
private final boolean required
private final boolean sensitive
private final boolean dynamic
@Deprecated private final boolean expressionLanguageSupported
private final ExpressionLanguageScope expressionLanguageScope
private final boolean dynamicallyModifiesClasspath
private final Class<? extends ControllerService> controllerServiceDefinition
ControllerService
that this Property refers
to; will be null if not identifying a ControllerService.private final List<Validator> validators
private final Set<PropertyDependency> dependencies
private final ResourceDefinition resourceDefinition
protected PropertyDescriptor(PropertyDescriptor.Builder builder)
public int compareTo(PropertyDescriptor o)
compareTo
in interface Comparable<PropertyDescriptor>
public ValidationResult validate(String input, ValidationContext context)
input
- the value to validatecontext
- the context of validationpublic String getDisplayName()
public String getName()
public String getDescription()
public String getDefaultValue()
public boolean isRequired()
public boolean isSensitive()
public boolean isDynamic()
public boolean isExpressionLanguageSupported()
public ExpressionLanguageScope getExpressionLanguageScope()
public boolean isDynamicClasspathModifier()
public Class<? extends ControllerService> getControllerServiceDefinition()
public List<AllowableValue> getAllowableValues()
public Set<PropertyDependency> getDependencies()
public ResourceDefinition getResourceDefinition()
Copyright © 2021 Apache NiFi Project. All rights reserved.