JabRef 5.15 · org.jabref.logic.bibtex.comparator.BibtexStringComparator

public Class BibtexStringComparator

Field Summary

Modifier and Type	Field and Description
private final boolean	considerRefs

Constructor Summary

Access	Constructor 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 Type	Method and Description
public int	compare(BibtexString the first object to be compared. s1, BibtexString the second object to be compared. s2) Implements java.util.Comparator.compare. Compares its two arguments for order.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

considerRefs	back to summary
private final boolean considerRefs

Constructor Detail

BibtexStringComparator	back 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

compare back to summary

compare	back 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`. Parameters s1:BibtexString the first object to be compared. s2:BibtexString 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

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.

Parameters

s1:BibtexString: the first object to be compared.
s2:BibtexString: 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