com.flexive.shared.search.query
Enum TreeValueNode.TreeValueComparator

java.lang.Object
  extended by java.lang.Enum<TreeValueNode.TreeValueComparator>
      extended by com.flexive.shared.search.query.TreeValueNode.TreeValueComparator
All Implemented Interfaces:
ObjectWithLabel, ValueComparator, java.io.Serializable, java.lang.Comparable<TreeValueNode.TreeValueComparator>
Enclosing class:
TreeValueNode

public static enum TreeValueNode.TreeValueComparator
extends java.lang.Enum<TreeValueNode.TreeValueComparator>
implements ValueComparator


Enum Constant Summary
CHILD
           
DIRECTCHILD
           
 
Method Summary
 FxString getLabel()
          Return the label to be displayed to the user.
 boolean isNeedsInput()
          Returns true if the comparator needs a value ("right-hand-side").
static TreeValueNode.TreeValueComparator valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static TreeValueNode.TreeValueComparator[] 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

CHILD

public static final TreeValueNode.TreeValueComparator CHILD

DIRECTCHILD

public static final TreeValueNode.TreeValueComparator DIRECTCHILD
Method Detail

values

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

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

valueOf

public static TreeValueNode.TreeValueComparator 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

isNeedsInput

public boolean isNeedsInput()
Returns true if the comparator needs a value ("right-hand-side"). For example, equality needs a value to compare to, while "is null" does not.

Specified by:
isNeedsInput in interface ValueComparator
Returns:
true if the comparator needs a value ("right-hand-side").

getLabel

public FxString getLabel()
Return the label to be displayed to the user.

Specified by:
getLabel in interface ObjectWithLabel
Specified by:
getLabel in interface ValueComparator
Returns:
the label to be displayed to the user.