Top Description Fields Constructors Methods
org.eclipse.jgit.lib

public Class RefComparator

extends Object
implements Comparator<Ref>
Class Inheritance
All Implemented Interfaces
java.util.Comparator
Imports
java.util.ArrayList, .Collection, .Collections, .Comparator, .List
Util for sorting (or comparing) Ref instances by name.

Useful for command line tools or writing out refs to file.

Field Summary

Modifier and TypeField and Description
public static final RefComparator
INSTANCE

Singleton instance of RefComparator

Constructor Summary

AccessConstructor and Description
public
RefComparator()

Method Summary

Modifier and TypeMethod and Description
public int
compare(Ref
the first object to be compared.
o1, Ref
the second object to be compared.
o2)

Implements java.util.Comparator.compare.

Compares its two arguments for order.

public static int

Returns:

standard Comparator result of < 0, 0, > 0.
compareTo(Ref
the reference instance.
o1, String
the name to compare to.
o2)

Compare a reference to a name.

public static int

Returns:

standard Comparator result of < 0, 0, > 0.
compareTo(Ref
the reference instance.
o1, Ref
the other reference instance.
o2)

Compare two references by name.

public static Collection<Ref>

Returns:

sorted collection of refs
sort(Collection<Ref>
collection to be sorted
refs)

Sorts the collection of refs, returning a new collection.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

INSTANCEback to summary
public static final RefComparator INSTANCE

Singleton instance of RefComparator

Constructor Detail

RefComparatorback to summary
public RefComparator()

Method Detail

compareback to summary
public int compare(Ref o1, Ref o2)

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
o1:Ref

the first object to be compared.

o2:Ref

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
compareToback to summary
public static int compareTo(Ref o1, String o2)

Compare a reference to a name.

Parameters
o1:Ref

the reference instance.

o2:String

the name to compare to.

Returns:int

standard Comparator result of < 0, 0, > 0.

compareToback to summary
public static int compareTo(Ref o1, Ref o2)

Compare two references by name.

Parameters
o1:Ref

the reference instance.

o2:Ref

the other reference instance.

Returns:int

standard Comparator result of < 0, 0, > 0.

sortback to summary
public static Collection<Ref> sort(Collection<Ref> refs)

Sorts the collection of refs, returning a new collection.

Parameters
refs:Collection<Ref>

collection to be sorted

Returns:Collection<Ref>

sorted collection of refs