Package docking.widgets.search

Class SearchLocationContext

java.lang.Object
docking.widgets.search.SearchLocationContext
All Implemented Interfaces:
Comparable<SearchLocationContext>
public class SearchLocationContext NEW extends Object implements Comparable<SearchLocationContext>
A class to hold context representation for SearchLocations.
See Also:

  • Field Details

  • Method Details

    • get

      public static SearchLocationContext get(String text)
      A factory method to create a context instance with the given text. The context created this way will have no special HTML formatting applied by getBoldMatchingText(), as no matching parts will be defined.
      Parameters:
      text - the text
      Returns:
      the context

    • get

      public static SearchLocationContext get(SearchLocationContext context)
      A factory method to provided as a convenience to handle null context objects.
      Parameters:
      context - the context to verify is not null
      Returns:
      the given context or the EMPTY_CONTEXT if the given context is null

    • getPlainText

      public String getPlainText()
      The full plain text of this context. Any non-negative line number will be prepended to the text.
      Returns:
      the text

    • getPlainText

      public String getPlainText(boolean includeLineNumber)
      Returns the plain text of this context, without html markup.
      Parameters:
      includeLineNumber - if true, any non-negative line number will be prepended to the text.
      Returns:
      the text

    • getDebugText

      public String getDebugText()
      Returns text that is helpful for debugging, such as printing to a console.
      Returns:
      the text

    • getBoldMatchingText

      public String getBoldMatchingText()
      Returns HTML text for this context. Any matching items embedded in the returned string will be bold. Any non-negative line number will be prepended to the text.
      Returns:
      the text

    • getBoldMatchingText

      public String getBoldMatchingText(boolean includeLineNumber)
      Returns HTML text for this context. Any matching items embedded in the returned string will be bold.
      Parameters:
      includeLineNumber - if true, any non-negative line number will be prepended to the text.
      Returns:
      the text

    • getMatches

      public List<String> getMatches()
      Returns any sub-strings of this context's overall text that match client-defined input See the SearchLocationContextBuilder for how to define matching text pieces
      Returns:
      the matching strings

    • getLineNumber

      public int getLineNumber()
      Returns the line number or -1 if the value has not been set.
      Returns:
      the line number

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • compareTo

      public int compareTo(SearchLocationContext other)
      Specified by:
      compareTo in interface Comparable<SearchLocationContext>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object