Module gg.xp.xivapi
Package gg.xp.xivapi.filters

Interface SearchFilter

public interface SearchFilter
Interface representing a search filter

  • Method Details

    • toFilterString

      String toFilterString()
      Returns:
      This search filter, formatted into a string.

    • toFilterStringWrapped

      default String toFilterStringWrapped()
      Alternative version of toFilterString() that should be called when this filter is going to be combined with other filters in such a way that it might need to be wrapped with parentheses. If that is the case, then this method should be overridden to do that.
      Returns:
      The same as toFilterString() but in a manner safe to use in a nested context.

    • or

      default SearchFilter or(SearchFilter other)
      Overload for Groovy "bitwise or" operator. Internally flattens nested levels, so that you can do something like x | y | z and it will be equivalent to or(x, y, z).
      Parameters:
      other - The filter to "or" with.
      Returns:
      The result.

    • and

      default SearchFilter and(SearchFilter other)
      Overload for Groovy "bitwise and" operator. Internally flattens nested levels, so that you can do something like x & y & z and it will be equivalent to and(x, y, z).
      Parameters:
      other - The filter to "and" with.
      Returns:
      The result.

    • bitwiseNegate

      default SearchFilter bitwiseNegate()
      Overload for Groovy "bitwise negate" operator.
      Returns:
      The negated filter.