|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.functor.core.comparator.Max<T>
public final class Max<T>
Adapts a Comparator
to the
BinaryFunction
interface.
Field Summary | |
---|---|
static Max<Comparable<?>> |
INSTANCE
Basic Max instance. |
Constructor Summary | |
---|---|
Max()
Create a new Max. |
|
Max(Comparator<T> comparator)
Create a new Max. |
Method Summary | ||
---|---|---|
boolean |
equals(Max<?> that)
Learn whether another Max is equal to this. |
|
boolean |
equals(Object that)
Indicates whether some other object is "equal to" this functor. |
|
T |
evaluate(T left,
T right)
Evaluate this function. |
|
int |
hashCode()
Returns a hash code for this functor adhering to the general Object.hashCode contract. |
|
static
|
instance()
Get a Max instance. |
|
static
|
instance(T right)
Get a Max UnaryFunction. |
|
String |
toString()
Returns a human readable description of this functor. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final Max<Comparable<?>> INSTANCE
Constructor Detail |
---|
public Max()
public Max(Comparator<T> comparator)
comparator
- Comparator to useMethod Detail |
---|
public T evaluate(T left, T right)
evaluate
in interface BinaryFunction<T,T,T>
left
- the L element of the ordered pair of argumentsright
- the R element of the ordered pair of arguments
public boolean equals(Object that)
Object.equals
contract.
Additionally, this method can return
true only if the specified Object implements
the same functor interface and is known to produce the same
results and/or side-effects for the same arguments (if any).
While implementators are strongly encouraged to override
the default Object implementation of this method,
note that the default Object implementation
does in fact adhere to the functor equals
contract.
equals
in interface Functor
equals
in class Object
that
- the object to compare this functor to
true
iff the given object implements
this functor interface, and is known to produce the same
results and/or side-effects for the same arguments
(if any).Functor.hashCode()
public boolean equals(Max<?> that)
that
- Max to test
public int hashCode()
Object.hashCode
contract.
Implementators are strongly encouraged but not
strictly required to override the default Object
implementation of this method.
hashCode
in interface Functor
hashCode
in class Object
Functor.equals(java.lang.Object)
public String toString()
Object
implementation of this method.
toString
in interface Functor
toString
in class Object
public static <T extends Comparable<?>> Max<T> instance()
public static <T extends Comparable<?>> UnaryFunction<T,T> instance(T right)
right
- the right side argument of the Max function
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |