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

pack-priv final Class NaturalOrdering

extends Ordering<Comparable<?>>
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Annotations
@GwtCompatible
serializable:true
@SuppressWarnings:unchecked, rawtypes
@ElementTypesAreNonnullByDefault
Static Imports
com.google.common.base.Preconditions.checkNotNull
An ordering that uses the natural order of the values.

Field Summary

Modifier and TypeField and Description
pack-priv static final NaturalOrdering
INSTANCE

private transient Ordering<@Nullable Comparable<?>>
nullsFirst

private transient Ordering<@Nullable Comparable<?>>
nullsLast

private static final long
serialVersionUID

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

Constructor Summary

AccessConstructor and Description
private
NaturalOrdering()

Method Summary

Modifier and TypeMethod and Description
public int
compare(Comparable<?>
the first object to be compared.
left, Comparable<?>
the second object to be compared.
right)

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

Implements java.util.Comparator.compare.

Compares its two arguments for order.
public <S extends Comparable<?>> Ordering<@Nullable S>
nullsFirst()

Overrides com.google.common.collect.Ordering.nullsFirst.

Returns an ordering that treats null as less than all other values and uses this to compare non-null values.
public <S extends Comparable<?>> Ordering<@Nullable S>
nullsLast()

Overrides com.google.common.collect.Ordering.nullsLast.

Returns an ordering that treats null as greater than all other values and uses this ordering to compare non-null values.
private Object
readResolve()

public <S extends Comparable<?>> 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:
allEqualarbitrarybinarySearchcompoundcompoundexplicitexplicitfromfromgreatestOfgreatestOfimmutableSortedCopyisOrderedisStrictlyOrderedleastOfleastOflexicographicalmaxmaxmaxmaxminminminminnaturalonKeysonResultOfsortedCopyusingToString

Field Detail

INSTANCEback to summary
pack-priv static final NaturalOrdering INSTANCE
nullsFirstback to summary
private transient Ordering<@Nullable Comparable<?>> nullsFirst
Annotations
@LazyInit
@CheckForNull
nullsLastback to summary
private transient Ordering<@Nullable Comparable<?>> nullsLast
Annotations
@LazyInit
@CheckForNull
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

NaturalOrderingback to summary
private NaturalOrdering()

Method Detail

compareback to summary
public int compare(Comparable<?> left, Comparable<?> right)

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
left:Comparable<?>

the first object to be compared.

right:Comparable<?>

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
nullsFirstback to summary
public <S extends Comparable<?>> Ordering<@Nullable S> nullsFirst()

Overrides com.google.common.collect.Ordering.nullsFirst.

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

Returns an ordering that treats null as less than all other values and uses this to compare non-null values.

The returned object is serializable if this object is serializable.

Java 8 users: Use Comparator.nullsFirst(thisComparator) instead.

Annotations
@Override
nullsLastback to summary
public <S extends Comparable<?>> Ordering<@Nullable S> nullsLast()

Overrides com.google.common.collect.Ordering.nullsLast.

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

Returns an ordering that treats null as greater than all other values and uses this ordering to compare non-null values.

The returned object is serializable if this object is serializable.

Java 8 users: Use Comparator.nullsLast(thisComparator) instead.

Annotations
@Override
readResolveback to summary
private Object readResolve()
reverseback to summary
public <S extends Comparable<?>> 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
@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