org.apache.nifi.annotation.behavior

Enum InputRequirement.Requirement

java.lang.Object

java.lang.Enum<InputRequirement.Requirement>

org.apache.nifi.annotation.behavior.InputRequirement.Requirement

All Implemented Interfaces:

Serializable, Comparable<InputRequirement.Requirement>

Enclosing class:

InputRequirement

public static enum InputRequirement.Requirement
extends Enum<InputRequirement.Requirement>

Enum Constant Summary

Enum Constants

Enum Constant and Description
INPUT_ALLOWED This value is used to indicate that the Processor will consume data from an incoming connection but does not require an incoming connection in order to perform its task.
INPUT_FORBIDDEN This value is used to indicate that the Processor is a "Source Processor" and does not accept incoming connections.
INPUT_REQUIRED This value is used to indicate that the Processor requires input from other Processors in order to run.

Method Summary

Methods

Modifier and Type	Method and Description
static InputRequirement.Requirement	valueOf(String name) Returns the enum constant of this type with the specified name.
static InputRequirement.Requirement[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INPUT_REQUIRED

public static final InputRequirement.Requirement INPUT_REQUIRED

This value is used to indicate that the Processor requires input from other Processors in order to run. As a result, the Processor will not be valid if it does not have any incoming connections.

INPUT_ALLOWED

public static final InputRequirement.Requirement INPUT_ALLOWED

This value is used to indicate that the Processor will consume data from an incoming connection but does not require an incoming connection in order to perform its task. If the InputRequirement annotation is not present, this is the default value that is used.

INPUT_FORBIDDEN

public static final InputRequirement.Requirement INPUT_FORBIDDEN

This value is used to indicate that the Processor is a "Source Processor" and does not accept incoming connections. Because the Processor does not pull FlowFiles from an incoming connection, it can be very confusing for users who create incoming connections to the Processor. As a result, this value can be used in order to clarify that incoming connections will not be used. This prevents the user from even creating such a connection.

Method Detail

values

public static InputRequirement.Requirement[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (InputRequirement.Requirement c : InputRequirement.Requirement.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static InputRequirement.Requirement valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null