Package org.apache.nifi.controller.queue

Enum Class SortColumn

java.lang.Object

java.lang.Enum<SortColumn>

org.apache.nifi.controller.queue.SortColumn

All Implemented Interfaces:

Serializable, Comparable<SortColumn>, Constable, Comparator<FlowFileSummary>

public enum SortColumn
extends Enum<SortColumn>
implements Comparator<FlowFileSummary>

Specifies which column to sort on when performing a Listing of FlowFiles via

invalid reference

FlowFileQueue#listFlowFiles(String, SortColumn, SortDirection)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FILENAME	Sort based on the 'filename' attribute of the FlowFile
FLOWFILE_AGE	Sort based on the age of the FlowFile.
FLOWFILE_SIZE	Sort based on the size of the FlowFile
FLOWFILE_UUID	Sort based on the UUID of the FlowFile
PENALIZATION	Sort based on when the FlowFile's penalization ends
QUEUE_POSITION	Sort based on the current position in the queue
QUEUED_DURATION	Sort based on how long the FlowFile has been sitting in the queue

Field Summary

Fields

Modifier and Type	Field	Description
private final Comparator<FlowFileSummary>	comparator

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SortColumn(Comparator<FlowFileSummary> comparator)

Method Summary

Modifier and Type	Method	Description
int	compare(FlowFileSummary o1, FlowFileSummary o2)
static SortColumn	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SortColumn[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Enum Constant Details

QUEUE_POSITION

public static final SortColumn QUEUE_POSITION

Sort based on the current position in the queue

FLOWFILE_UUID

public static final SortColumn FLOWFILE_UUID

Sort based on the UUID of the FlowFile

FILENAME

public static final SortColumn FILENAME

Sort based on the 'filename' attribute of the FlowFile

FLOWFILE_SIZE

public static final SortColumn FLOWFILE_SIZE

Sort based on the size of the FlowFile

QUEUED_DURATION

public static final SortColumn QUEUED_DURATION

Sort based on how long the FlowFile has been sitting in the queue

FLOWFILE_AGE

public static final SortColumn FLOWFILE_AGE

Sort based on the age of the FlowFile. I.e., the time at which the FlowFile's "greatest ancestor" entered the flow

PENALIZATION

public static final SortColumn PENALIZATION

Sort based on when the FlowFile's penalization ends

Field Details

comparator

private final Comparator<FlowFileSummary> comparator

Constructor Details

SortColumn

private SortColumn(Comparator<FlowFileSummary> comparator)

Method Details

values

public static SortColumn[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SortColumn valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

compare

public int compare(FlowFileSummary o1,
 FlowFileSummary o2)

Specified by:

compare in interface Comparator<FlowFileSummary>