Verified Owner
Top Fields Constructors Methods
org.jabref.logic.bibtex.comparator

public Class BibtexStringComparator

extends Object
implements Comparator<BibtexString>
Class Inheritance
All Implemented Interfaces
java.util.Comparator
Imports
java.util.Comparator, .Locale, org.jabref.model.entry.BibtexString

Field Summary

Modifier and TypeField and Description
private final boolean
considerRefs

Constructor Summary

AccessConstructor and Description
public
BibtexStringComparator(boolean
Indicates whether the strings should be sorted according to internal references in addition to alphabetical sorting.
considerRefs)

Method Summary

Modifier and TypeMethod and Description
public int
compare(BibtexString s1, BibtexString s2)

Implements java.util.Comparator.compare.

Compares its two arguments for order.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

considerRefsback to summary
private final boolean considerRefs

Constructor Detail

BibtexStringComparatorback to summary
public BibtexStringComparator(boolean considerRefs)
Parameters
considerRefs:boolean

Indicates whether the strings should be sorted according to internal references in addition to alphabetical sorting.

Method Detail

compareback to summary
public int compare(BibtexString s1, BibtexString s2)

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.

Annotations
@Override