Top Description Fields Constructors Methods
com.google.common.collect

pack-priv final Class ReverseOrdering<T extends @Nullable Object>

extends Ordering<T extends @Nullable Object>
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Annotations
@GwtCompatible
serializable:true
@ElementTypesAreNonnullByDefault
Static Imports
com.google.common.base.Preconditions.checkNotNull
An ordering that uses the reverse of a given order.

Field Summary

Modifier and TypeField and Description
pack-priv final Ordering<? super T>
forwardOrder

private static final long
serialVersionUID

Inherited from com.google.common.collect.Ordering:
LEFT_IS_GREATERRIGHT_IS_GREATER

Constructor Summary

AccessConstructor and Description
pack-priv
ReverseOrdering(Ordering<? super T> forwardOrder)

Method Summary

Modifier and TypeMethod and Description
public int
compare(T
the first object to be compared.
a, T
the second object to be compared.
b)

Implements abstract com.google.common.collect.Ordering.compare.

Implements java.util.Comparator.compare.

Compares its two arguments for order.
public boolean
equals(Object
the reference object with which to compare.
object)

Overrides java.lang.Object.equals.

Implements java.util.Comparator.equals.

Indicates whether some other object is "equal to" this comparator.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public <E extends T> E
max(E
value to compare, returned if greater than or equal to b.
a, E
value to compare.
b)

Overrides com.google.common.collect.Ordering.max.

Returns the greater of the two values according to this ordering.
public <E extends T> E
max(E
value to compare, returned if greater than or equal to the rest.
a, E
value to compare
b, E
value to compare
c, E...
values to compare
rest)

Overrides com.google.common.collect.Ordering.max.

Returns the greatest of the specified values according to this ordering.
public <E extends T> E
max(Iterator<E>
the iterator whose maximum element is to be determined
iterator)

Overrides com.google.common.collect.Ordering.max.

Returns the greatest of the specified values according to this ordering.
public <E extends T> E
max(Iterable<E>
the iterable whose maximum element is to be determined
iterable)

Overrides com.google.common.collect.Ordering.max.

Returns the greatest of the specified values according to this ordering.
public <E extends T> E
min(E
value to compare, returned if less than or equal to b.
a, E
value to compare.
b)

Overrides com.google.common.collect.Ordering.min.

Returns the lesser of the two values according to this ordering.
public <E extends T> E
min(E
value to compare, returned if less than or equal to the rest.
a, E
value to compare
b, E
value to compare
c, E...
values to compare
rest)

Overrides com.google.common.collect.Ordering.min.

Returns the least of the specified values according to this ordering.
public <E extends T> E
min(Iterator<E>
the iterator whose minimum element is to be determined
iterator)

Overrides com.google.common.collect.Ordering.min.

Returns the least of the specified values according to this ordering.
public <E extends T> E
min(Iterable<E>
the iterable whose minimum element is to be determined
iterable)

Overrides com.google.common.collect.Ordering.min.

Returns the least of the specified values according to this ordering.
public <S extends T> Ordering<S>
reverse()

Overrides com.google.common.collect.Ordering.reverse.

Returns the reverse of this ordering; the Ordering equivalent to Collections#reverseOrder(Comparator).
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from com.google.common.collect.Ordering:
allEqualarbitrarybinarySearchcompoundcompoundexplicitexplicitfromfromgreatestOfgreatestOfimmutableSortedCopyisOrderedisStrictlyOrderedleastOfleastOflexicographicalnaturalnullsFirstnullsLastonKeysonResultOfsortedCopyusingToString

Field Detail

forwardOrderback to summary
pack-priv final Ordering<? super T> forwardOrder
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

ReverseOrderingback to summary
pack-priv ReverseOrdering(Ordering<? super T> forwardOrder)

Method Detail

compareback to summary
public int compare(T a, T b)

Implements abstract com.google.common.collect.Ordering.compare.

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must ensure that signum(compare(x, y)) == -signum(compare(y, x)) for all x and y. (This implies that compare(x, y) must throw an exception if and only if compare(y, x) throws an exception.)

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that signum(compare(x, z))==signum(compare(y, z)) for all z.

Parameters
a:T

the first object to be compared.

b:T

the second object to be compared.

Returns:int

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

Annotations
@Override
equalsback to summary
public boolean equals(Object object)

Overrides java.lang.Object.equals.

Implements java.util.Comparator.equals.

Doc from java.util.Comparator.equals.

Indicates whether some other object is "equal to" this comparator. This method must obey the general contract of Object#equals(Object). Additionally, this method can return true only if the specified object is also a comparator and it imposes the same ordering as this comparator. Thus, comp1.equals(comp2) implies that signum(comp1.compare(o1, o2))==signum(comp2.compare(o1, o2)) for every object reference o1 and o2.

Note that it is always safe not to override Object.equals(Object). However, overriding this method may, in some cases, improve performance by allowing programs to determine that two distinct comparators impose the same order.

Parameters
object:Object

the reference object with which to compare.

Returns:boolean

true only if the specified object is also a comparator and it imposes the same ordering as this comparator.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
maxback to summary
public <E extends T> E max(E a, E b)

Overrides com.google.common.collect.Ordering.max.

Doc from com.google.common.collect.Ordering.max.

Returns the greater of the two values according to this ordering. If the values compare as 0, the first is returned.

Implementation Note

this method is invoked by the default implementations of the other max overloads, so overriding it will affect their behavior.

Note

Consider using Comparators.max(a, b, thisComparator) instead. If thisComparator is Ordering#natural, then use Comparators.max(a, b).

Parameters
a:E

value to compare, returned if greater than or equal to b.

b:E

value to compare.

Annotations
@Override
maxback to summary
public <E extends T> E max(E a, E b, E c, E... rest)

Overrides com.google.common.collect.Ordering.max.

Doc from com.google.common.collect.Ordering.max.

Returns the greatest of the specified values according to this ordering. If there are multiple greatest values, the first of those is returned.

Java 8+ users: Use Collections.max(Arrays.asList(a, b, c...), thisComparator) instead (but note that it does not guarantee which tied maximum element is returned).

Parameters
a:E

value to compare, returned if greater than or equal to the rest.

b:E

value to compare

c:E

value to compare

rest:E[]

values to compare

Annotations
@Override
maxback to summary
public <E extends T> E max(Iterator<E> iterator)

Overrides com.google.common.collect.Ordering.max.

Doc from com.google.common.collect.Ordering.max.

Returns the greatest of the specified values according to this ordering. If there are multiple greatest values, the first of those is returned. The iterator will be left exhausted: its hasNext() method will return false.

Java 8+ users: Use Streams.stream(iterator).max(thisComparator).get() instead (but note that it does not guarantee which tied maximum element is returned).

Parameters
iterator:Iterator<E>

the iterator whose maximum element is to be determined

Annotations
@Override
maxback to summary
public <E extends T> E max(Iterable<E> iterable)

Overrides com.google.common.collect.Ordering.max.

Doc from com.google.common.collect.Ordering.max.

Returns the greatest of the specified values according to this ordering. If there are multiple greatest values, the first of those is returned.

Java 8+ users: If iterable is a Collection, use Collections.max(collection, thisComparator) instead. Otherwise, use Streams.stream(iterable).max(thisComparator).get() instead. Note that these alternatives do not guarantee which tied maximum element is returned.

Parameters
iterable:Iterable<E>

the iterable whose maximum element is to be determined

Annotations
@Override
minback to summary
public <E extends T> E min(E a, E b)

Overrides com.google.common.collect.Ordering.min.

Doc from com.google.common.collect.Ordering.min.

Returns the lesser of the two values according to this ordering. If the values compare as 0, the first is returned.

Implementation Note

this method is invoked by the default implementations of the other min overloads, so overriding it will affect their behavior.

Note

Consider using Comparators.min(a, b, thisComparator) instead. If thisComparator is Ordering#natural, then use Comparators.min(a, b).

Parameters
a:E

value to compare, returned if less than or equal to b.

b:E

value to compare.

Annotations
@Override
minback to summary
public <E extends T> E min(E a, E b, E c, E... rest)

Overrides com.google.common.collect.Ordering.min.

Doc from com.google.common.collect.Ordering.min.

Returns the least of the specified values according to this ordering. If there are multiple least values, the first of those is returned.

Java 8+ users: Use Collections.min(Arrays.asList(a, b, c...), thisComparator) instead (but note that it does not guarantee which tied minimum element is returned).

Parameters
a:E

value to compare, returned if less than or equal to the rest.

b:E

value to compare

c:E

value to compare

rest:E[]

values to compare

Annotations
@Override
minback to summary
public <E extends T> E min(Iterator<E> iterator)

Overrides com.google.common.collect.Ordering.min.

Doc from com.google.common.collect.Ordering.min.

Returns the least of the specified values according to this ordering. If there are multiple least values, the first of those is returned. The iterator will be left exhausted: its hasNext() method will return false.

Java 8+ users: Use Streams.stream(iterator).min(thisComparator).get() instead (but note that it does not guarantee which tied minimum element is returned).

Parameters
iterator:Iterator<E>

the iterator whose minimum element is to be determined

Annotations
@Override
minback to summary
public <E extends T> E min(Iterable<E> iterable)

Overrides com.google.common.collect.Ordering.min.

Doc from com.google.common.collect.Ordering.min.

Returns the least of the specified values according to this ordering. If there are multiple least values, the first of those is returned.

Java 8+ users: If iterable is a Collection, use Collections.min(collection, thisComparator) instead. Otherwise, use Streams.stream(iterable).min(thisComparator).get() instead. Note that these alternatives do not guarantee which tied minimum element is returned.

Parameters
iterable:Iterable<E>

the iterable whose minimum element is to be determined

Annotations
@Override
reverseback to summary
public <S extends T> Ordering<S> reverse()

Overrides com.google.common.collect.Ordering.reverse.

Doc from com.google.common.collect.Ordering.reverse.

Returns the reverse of this ordering; the Ordering equivalent to Collections#reverseOrder(Comparator).

Java 8+ users: Use thisComparator.reversed() instead.

Annotations
@SuppressWarnings:unchecked
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations
@Override