Package org.apache.nifi.processor

Class Relationship

java.lang.Object

org.apache.nifi.processor.Relationship

All Implemented Interfaces:

Comparable<Relationship>

public final class Relationship
extends Object
implements Comparable<Relationship>

An immutable object for holding information about a type of relationship.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Relationship.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final Relationship	ANONYMOUS
private final String	description	A user displayable description of the purpose of this relationship.
private final int	hashCode	The hash code, which is computed in the constructor because it is hashed very frequently and the hash code is constant
private final boolean	isAutoTerminate	The flag which tells the controller to auto terminate this relationship, so that the processor can be run even if it does not have connections from this relationship
private final String	name	The proper name of the relationship.
static final Relationship	SELF

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Relationship(Relationship.Builder builder)

Method Summary

Modifier and Type	Method	Description
int	compareTo(Relationship o)
boolean	equals(Object other)
String	getDescription()
String	getName()
int	hashCode()
boolean	isAutoTerminated()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SELF

public static final Relationship SELF

ANONYMOUS

public static final Relationship ANONYMOUS

name

private final String name

The proper name of the relationship. Determines the relationship 'identity'

description

private final String description

A user displayable description of the purpose of this relationship.

hashCode

private final int hashCode

The hash code, which is computed in the constructor because it is hashed very frequently and the hash code is constant

isAutoTerminate

private final boolean isAutoTerminate

The flag which tells the controller to auto terminate this relationship, so that the processor can be run even if it does not have connections from this relationship

Constructor Details

Relationship

protected Relationship(Relationship.Builder builder)

Method Details

compareTo

public int compareTo(Relationship o)

Specified by:

compareTo in interface Comparable<Relationship>

getName

public String getName()

getDescription

public String getDescription()

isAutoTerminated

public boolean isAutoTerminated()

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