info.bioinfweb.commons.io

Class StreamLocationProviderOffsetComparator

java.lang.Object

info.bioinfweb.commons.io.StreamLocationProviderOffsetComparator

All Implemented Interfaces:

java.util.Comparator<StreamLocationProvider>

public class StreamLocationProviderOffsetComparator
extends java.lang.Object
implements java.util.Comparator<StreamLocationProvider>

Comparator for instances of StreamLocationProvider, which uses StreamLocationProvider.getCharacterOffset() as the only comparison criterion.

Note that the line and column number properties are not taken into account. As a consequence this comparator is not necessarily consistent with the equals(Object) methods of the implementations of StreamLocationProvider. (If this comparator returns 0 for two objects, these objects are not necessarily equal, they only have the same character offset.) Therefore this comparator should not be used together with sorted sets or sorted maps, as described in the documentation of Comparator.

Since:

1.2.0

Author:

Ben Stöver

Constructor Summary

Constructors

Constructor and Description
StreamLocationProviderOffsetComparator()

Method Summary

Modifier and Type	Method and Description
int	compare(StreamLocationProvider o1, StreamLocationProvider o2)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

StreamLocationProviderOffsetComparator

public StreamLocationProviderOffsetComparator()

Method Detail

compare

public int compare(StreamLocationProvider o1,
                   StreamLocationProvider o2)

Specified by:

compare in interface java.util.Comparator<StreamLocationProvider>