Package org.opengrok.indexer.search.context

Class FormattedLines

java.lang.Object
org.opengrok.indexer.search.context.FormattedLines
public class FormattedLines extends Object
Represents structured results from ContextFormatter that can be merged with other instances.

UnifiedHighlighter returns results separated by field, and OGKUnifiedHighlighter merges them together to return a coherent result for presentation.

  • Constructor Details

    • FormattedLines

      public FormattedLines()

  • Method Details

    • getCount

      public int getCount()

    • getFooter

      public String getFooter()
      Returns:
      the footer

    • setFooter

      public void setFooter(String value)

    • isLimited

      public boolean isLimited()

    • setLimited

      public void setLimited(boolean value)

    • pop

      public String pop()
      Removes the highest line from the instance.
      Returns:
      a defined value
      Throws:
      NoSuchElementException - if the instance is empty

    • put

      public String put(int lineno, String line)
      Sets the specified String line for the specified line number, replacing any previous entry for the same line number.
      Parameters:
      lineno - a value
      line - a defined instance
      Returns:
      the former value or null

    • merge

      public FormattedLines merge(FormattedLines other)
      Creates a new instance with lines merged from this instance and other. Any lines in common for the same line number are taken from this instance rather than other; and likewise for getFooter().

      isLimited() will be true if either is true, but the value is suspect since it cannot be truly known if the merged result is actually the unlimited result.

      Parameters:
      other - a defined instance
      Returns:
      a defined instance

    • toString

      public String toString()
      Overrides:
      toString in class Object