org.apache.nifi.components

Class PropertyDescriptor.Builder

java.lang.Object

org.apache.nifi.components.PropertyDescriptor.Builder

Enclosing class:

PropertyDescriptor

public static final class PropertyDescriptor.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
private List<AllowableValue>	allowableValues
private Class<? extends ControllerService>	controllerServiceDefinition
private String	defaultValue
private String	description
private String	displayName
private boolean	dynamic
private boolean	expressionLanguageSupported
private String	name
private boolean	required
private boolean	sensitive
private List<Validator>	validators

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PropertyDescriptor.Builder	addValidator(Validator validator)
PropertyDescriptor.Builder	allowableValues(AllowableValue... values) Sets the Allowable Values for this Property
<E extends Enum<E>> PropertyDescriptor.Builder	allowableValues(E[] values)
PropertyDescriptor.Builder	allowableValues(Set<String> values)
PropertyDescriptor.Builder	allowableValues(String... values)
PropertyDescriptor	build()
PropertyDescriptor.Builder	defaultValue(String value) Specifies the initial value and the default value that will be used if the user does not specify a value.
PropertyDescriptor.Builder	description(String description)
PropertyDescriptor.Builder	displayName(String displayName) Sets a unique id for the property.
PropertyDescriptor.Builder	dynamic(boolean dynamic)
PropertyDescriptor.Builder	expressionLanguageSupported(boolean supported) Sets the value indicating whether or not this Property will support the Attribute Expression Language.
PropertyDescriptor.Builder	fromPropertyDescriptor(PropertyDescriptor specDescriptor)
PropertyDescriptor.Builder	identifiesControllerService(Class<? extends ControllerService> controllerServiceDefinition) Specifies that this property provides the identifier of a Controller Service that implements the given interface
private boolean	isValueAllowed(String value)
PropertyDescriptor.Builder	name(String name) Sets the property name.
PropertyDescriptor.Builder	required(boolean required)
PropertyDescriptor.Builder	sensitive(boolean sensitive)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

displayName

private String displayName

name

private String name

description

private String description

defaultValue

private String defaultValue

allowableValues

private List<AllowableValue> allowableValues

required

private boolean required

sensitive

private boolean sensitive

expressionLanguageSupported

private boolean expressionLanguageSupported

dynamic

private boolean dynamic

controllerServiceDefinition

private Class<? extends ControllerService> controllerServiceDefinition

validators

private List<Validator> validators

Constructor Detail

Builder

public Builder()

Method Detail

fromPropertyDescriptor

public PropertyDescriptor.Builder fromPropertyDescriptor(PropertyDescriptor specDescriptor)

displayName

public PropertyDescriptor.Builder displayName(String displayName)

Sets a unique id for the property. This field is optional and if not specified the PropertyDescriptor's name will be used as the identifying attribute. However, by supplying an id, the PropertyDescriptor's name can be changed without causing problems. This is beneficial because it allows a User Interface to represent the name differently.

Parameters:

displayName - of the property

Returns:

the builder

name

public PropertyDescriptor.Builder name(String name)

Sets the property name.

Parameters:

name - of the property

Returns:

the builder

expressionLanguageSupported

public PropertyDescriptor.Builder expressionLanguageSupported(boolean supported)

Sets the value indicating whether or not this Property will support the Attribute Expression Language.

Parameters:

supported - true if yes; false otherwise

Returns:

the builder

description

public PropertyDescriptor.Builder description(String description)

Parameters:

description - of the property

Returns:

the builder

defaultValue

public PropertyDescriptor.Builder defaultValue(String value)

Specifies the initial value and the default value that will be used if the user does not specify a value. When build() is called, if Allowable Values have been set (see allowableValues(AllowableValue...)) and this value is not one of those Allowable Values and Exception will be thrown. If the Allowable Values have been set using the allowableValues(AllowableValue...) method, the default value should be set to the "Value" of the AllowableValue object (see AllowableValue.getValue()).

Parameters:

value - default value

Returns:

the builder

dynamic

public PropertyDescriptor.Builder dynamic(boolean dynamic)

allowableValues

public PropertyDescriptor.Builder allowableValues(Set<String> values)

Parameters:

values - contrained set of values

Returns:

the builder

allowableValues

public <E extends Enum<E>> PropertyDescriptor.Builder allowableValues(E[] values)

allowableValues

public PropertyDescriptor.Builder allowableValues(String... values)

Parameters:

values - constrained set of values

Returns:

the builder

allowableValues

public PropertyDescriptor.Builder allowableValues(AllowableValue... values)

Sets the Allowable Values for this Property

Parameters:

values - contrained set of values

Returns:

the builder

required

public PropertyDescriptor.Builder required(boolean required)

Parameters:

required - true if yes; false otherwise

Returns:

the builder

sensitive

public PropertyDescriptor.Builder sensitive(boolean sensitive)

Parameters:

sensitive - true if sensitive; false otherwise

Returns:

the builder

addValidator

public PropertyDescriptor.Builder addValidator(Validator validator)

Parameters:

validator - for the property

Returns:

the builder

identifiesControllerService

public PropertyDescriptor.Builder identifiesControllerService(Class<? extends ControllerService> controllerServiceDefinition)

Specifies that this property provides the identifier of a Controller Service that implements the given interface

Parameters:

controllerServiceDefinition - the interface that is implemented by the Controller Service

Returns:

the builder

isValueAllowed

private boolean isValueAllowed(String value)

build

public PropertyDescriptor build()

Returns:

a PropertyDescriptor as configured

Throws:

IllegalStateException - if allowable values are configured but no default value is set, or the default value is not contained within the allowable values.