org.apache.tools.ant.types

Class Comparison

Known Direct Subclasses:
Length.When, SizeSelector.SizeComparisons

public class Comparison
extends EnumeratedAttribute

EnumeratedAttribute for generic comparisons. Accepts values "equal", "greater", "more", "less", "ne" (not equal), "ge" (greater or equal), "le" (less or equal), "eq" (equal), "gt" (greater), "lt" (less).
Since:
Ant 1.7

Field Summary

static Comparison
EQUAL
Equal Comparison.
static Comparison
GREATER
Greater Comparison.
static Comparison
GREATER_EQUAL
Greater-or-Equal Comparison.
static Comparison
LESS
Less Comparison.
static Comparison
LESS_EQUAL
Less-or-Equal Comparison.
static Comparison
NOT_EQUAL
Not-Equal Comparison.

Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute

value

Constructor Summary

Comparison()
Default constructor.
Comparison(String value)
Construct a new Comparison with the specified value.

Method Summary

boolean
evaluate(int comparisonResult)
Evaluate a comparison result as from Comparator.compare() or Comparable.compareTo().
String[]
getValues()
Return the possible values.

Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute

containsValue, getIndex, getInstance, getValue, getValues, indexOfValue, setValue, toString

Field Details

EQUAL

public static final Comparison EQUAL
Equal Comparison.

GREATER

public static final Comparison GREATER
Greater Comparison.

GREATER_EQUAL

public static final Comparison GREATER_EQUAL
Greater-or-Equal Comparison.

LESS

public static final Comparison LESS
Less Comparison.

LESS_EQUAL

public static final Comparison LESS_EQUAL
Less-or-Equal Comparison.

NOT_EQUAL

public static final Comparison NOT_EQUAL
Not-Equal Comparison.

Constructor Details

Comparison

public Comparison()
Default constructor.

Comparison

public Comparison(String value)
Construct a new Comparison with the specified value.
Parameters:
value - the EnumeratedAttribute value.

Method Details

evaluate

public boolean evaluate(int comparisonResult)
Evaluate a comparison result as from Comparator.compare() or Comparable.compareTo().
Parameters:
comparisonResult - the result to evaluate.
Returns:
true if the comparison result fell within the parameters of this Comparison.

getValues

public String[] getValues()
Return the possible values.
Overrides:
getValues in interface EnumeratedAttribute
Returns:
String[] of EnumeratedAttribute values.