AnnotationComparator (Apache OpenNLP UIMA Annotators 1.9.5 API)
Date: 2026-06-18

opennlp.uima.util

## Class AnnotationComparator

- java.lang.Object
- - opennlp.uima.util.AnnotationComparator

- All Implemented Interfaces:
    Comparator<org.apache.uima.cas.text.AnnotationFS>

      public class AnnotationComparator
      extends Object
      implements Comparator<org.apache.uima.cas.text.AnnotationFS>

  Checks two annotations for equality.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `AnnotationComparator()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `int` | `compare(org.apache.uima.cas.text.AnnotationFS a, org.apache.uima.cas.text.AnnotationFS b)` Compares the begin indexes of the annotations.

    - ### Methods inherited from class java.lang.Object

      `equals, 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

    - #### AnnotationComparator

          public AnnotationComparator()

  - ### Method Detail

    - #### compare

          public int compare(org.apache.uima.cas.text.AnnotationFS a,
                             org.apache.uima.cas.text.AnnotationFS b)

      Compares the begin indexes of the annotations.
      Specified by:
        `compare` in interface `Comparator<org.apache.uima.cas.text.AnnotationFS>`
      Parameters:
        `a` - - first annotation
        `b` - - second annotation
      Returns:
        0 if equals, < 0 if before and > 0 if after

Copyright © 2026 The Apache Software Foundation. All rights reserved.