flux.file
Enum SortOrder

java.lang.Object
  extended by java.lang.Enum<SortOrder>
      extended by flux.file.SortOrder
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SortOrder>

public enum SortOrder
extends java.lang.Enum<SortOrder>

The available sorting algorithms for ordering the results from file triggers.

Author:
Copyright 2014 Flux Corporation. All rights reserved.

Enum Constant Summary
FILENAME_ASCENDING
          Lists files by filename in ascending order.
FILENAME_DESCENDING
          Lists files by filename in descending order.
NEWEST_FIRST
          Lists the most recently modified files first.
OLDEST_FIRST
          Lists the least recently modified files first.
 
Method Summary
static SortOrder valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static SortOrder[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

FILENAME_ASCENDING

public static final SortOrder FILENAME_ASCENDING
Lists files by filename in ascending order. For example, "a.txt" comes before "z.txt".


FILENAME_DESCENDING

public static final SortOrder FILENAME_DESCENDING
Lists files by filename in descending order. For example, "z.txt" comes before "a.txt".


NEWEST_FIRST

public static final SortOrder NEWEST_FIRST
Lists the most recently modified files first. For example, a file last modified one minute ago comes before a file last modified one hour ago.


OLDEST_FIRST

public static final SortOrder OLDEST_FIRST
Lists the least recently modified files first. For example, a file last modified one hour ago comes before a file last modified one minute ago.

Method Detail

values

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

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

valueOf

public static SortOrder valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null


© 2014 Flux Corporation. All rights reserved.