org.apache.nifi.controller.queue

Enum SortColumn

java.lang.Object

java.lang.Enum<SortColumn>

org.apache.nifi.controller.queue.SortColumn

All Implemented Interfaces:

Serializable, Comparable<SortColumn>, Comparator<FlowFileSummary>

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

Specifies which column to sort on when performing a Listing of FlowFiles via FlowFileQueue#listFlowFiles(String, SortColumn, SortDirection)

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
private Comparator<FlowFileSummary>	comparator

Method Summary

Modifier and Type	Method and Description
int	compare(FlowFileSummary o1, FlowFileSummary o2)
static SortColumn	valueOf(String name) Returns the enum constant of this type with the specified name.
static SortColumn[]	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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Enum Constant Detail

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 Detail

comparator

private final Comparator<FlowFileSummary> comparator

Method Detail

values

public static SortColumn[] 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 (SortColumn c : SortColumn.values())
    System.out.println(c);

Returns:

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

valueOf

public static SortColumn 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

compare

public int compare(FlowFileSummary o1,
                   FlowFileSummary o2)

Specified by:

compare in interface Comparator<FlowFileSummary>