Package io.jenkins.plugins.batchcontrol.store

Class RecordPage<T>

java.lang.Object
io.jenkins.plugins.batchcontrol.store.RecordPage<T>
Type Parameters:
T - record type
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public final class RecordPage<T> extends Object
One page of a bounded record query: the rows to render plus what the pager needs.

A query reads the requested months newest first and stops once it has read the query's scan cap of records. getMatched() counts the matches among the records that were read; when isTruncated() is true older records exist that were not read, so the count is a lower bound and the screen should say "narrow the filter" instead of showing it as a total.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<T>
    getItems()
    The rows of this page, newest first.
    int
    getMatched()
    Matching records among those read (exact when not isTruncated()).
    int
    getOversized()
    Lines of the months read that were longer than ReverseLineReader.MAX_LINE_BYTES and therefore skipped (security-11 N-02).
    int
    getUnreadable()
    Lines among those read that could not be parsed (a torn or damaged line) and were therefore skipped.
    boolean
    isHasNext()
    Whether a further page of matches exists among the records read.
    boolean
    isTruncated()
    Whether the scan cap stopped the query before the oldest requested record.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • getItems

      public List<T> getItems()
      The rows of this page, newest first.

    • getMatched

      public int getMatched()
      Matching records among those read (exact when not isTruncated()).

    • isTruncated

      public boolean isTruncated()
      Whether the scan cap stopped the query before the oldest requested record.

    • getOversized

      public int getOversized()
      Lines of the months read that were longer than ReverseLineReader.MAX_LINE_BYTES and therefore skipped (security-11 N-02). Every read path, CSV exports included, skips such a line, so a screen showing a non-zero count should say that records were skipped rather than look complete.

    • getUnreadable

      public int getUnreadable()
      Lines among those read that could not be parsed (a torn or damaged line) and were therefore skipped. Their time is unknown; only their position tells that they were appended within the part of the log the query read.

    • isHasNext

      public boolean isHasNext()
      Whether a further page of matches exists among the records read.