Interface SearchFilter<T>

  • Type Parameters:
    T - the type to which this search filter applies
    All Known Subinterfaces:
    DefaultProfileSearchFilter

    public interface SearchFilter<T>
    A search filter that can be passed to search methods.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DEFAULT_SEARCH_RANGE
      Defines the default search range.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getResultFrom()
      Returns the from value (inclusive) for the search results.
      int getResultTo()
      Returns the to value (exclusive) for the search results.
      void setResultRange​(int from, int to)
      Returns search results between from, inclusive, and to, exclusive.
    • Field Detail

      • DEFAULT_SEARCH_RANGE

        static final int DEFAULT_SEARCH_RANGE
        Defines the default search range.
        See Also:
        Constant Field Values
    • Method Detail

      • getResultFrom

        int getResultFrom()
        Returns the from value (inclusive) for the search results.
        Returns:
        results from (inclusive)
      • getResultTo

        int getResultTo()
        Returns the to value (exclusive) for the search results.
        Returns:
        results to (exclusive)
      • setResultRange

        void setResultRange​(int from,
                            int to)
        Returns search results between from, inclusive, and to, exclusive. If from and to are equal, the returned results are empty.
        Parameters:
        from - results from (inclusive)
        to - results to (exclusive)
        Throws:
        IllegalArgumentException - invalid range values: (to < from || from < 0 || to < 0)