Class BaseCharFilter

All Implemented Interfaces:
Closeable, AutoCloseable, Readable
Direct Known Subclasses:
CJKWidthCharFilter, HTMLStripCharFilter, MappingCharFilter, PatternReplaceCharFilter

public abstract class BaseCharFilter extends CharFilter
Base utility class for implementing a CharFilter. You subclass this, and then record mappings by calling addOffCorrectMap(int, int), and then invoke the correct method to correct an offset.
  • Constructor Details

    • BaseCharFilter

      public BaseCharFilter(Reader in)
  • Method Details

    • correct

      protected int correct(int currentOff)
      Retrieve the corrected offset.
      Specified by:
      correct in class CharFilter
    • getLastCumulativeDiff

      protected int getLastCumulativeDiff()
    • addOffCorrectMap

      protected void addOffCorrectMap(int off, int cumulativeDiff)
      Adds an offset correction mapping at the given output stream offset.

      Assumption: the offset given with each successive call to this method will not be smaller than the offset given at the previous invocation.

      off - The output stream offset at which to apply the correction
      cumulativeDiff - The input offset is given by adding this to the output offset