org.jboss.forge.furnace.util

Enum WeightedComparator

java.lang.Object

java.lang.Enum<WeightedComparator>

org.jboss.forge.furnace.util.WeightedComparator

All Implemented Interfaces:

Serializable, Comparable<WeightedComparator>, Comparator<Weighted>

public enum WeightedComparator
extends Enum<WeightedComparator>
implements Comparator<Weighted>

Compares Weighted objects.

Author:

Lincoln Baxter, III

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Methods

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

equals

Enum Constant Detail

INSTANCE

public static final WeightedComparator INSTANCE

Method Detail

values

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

Returns:

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

valueOf

public static WeightedComparator 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(Weighted left,
          Weighted right)

Specified by:

compare in interface Comparator<Weighted>