Package org.identityconnectors.framework.common.objects.filter

Interface FilterVisitor<R,P>

Type Parameters:
R - The return type of this visitor's methods. Use Void for visitors that do not need to return results.
P - The type of the additional parameter to this visitor's methods. Use Void for visitors that do not need an additional parameter.
All Known Implementing Classes:
FilteredResultsHandlerVisitor
public interface FilterVisitor<R,P>
A visitor of Filters, in the style of the visitor design pattern.

Classes implementing this interface can query filters in a type-safe manner. When a visitor is passed to a filter's accept method, the corresponding visit method most applicable to that filter is invoked.

Since:
1.4

  • Method Details

    • visitAndFilter

      R visitAndFilter(P p, AndFilter filter)
      Visits an and filter.

      Implementation note: for the purposes of matching, an empty sub-filters should always evaluate to true.

      Parameters:
      p - A visitor specified parameter.
      filter - The visited filter.
      Returns:
      Returns a visitor specified result.

    • visitContainsFilter

      R visitContainsFilter(P p, ContainsFilter filter)
      Visits a contains filter.
      Parameters:
      p - A visitor specified parameter.
      filter - The visited filter.
      Returns:
      Returns a visitor specified result.

    • visitContainsAllValuesFilter

      R visitContainsAllValuesFilter(P p, ContainsAllValuesFilter filter)
      Visits a containsAll filter.
      Parameters:
      p - A visitor specified parameter.
      filter - The visited filter.
      Returns:
      Returns a visitor specified result.

    • visitEqualsFilter

      R visitEqualsFilter(P p, EqualsFilter filter)
      Visits a equality filter.
      Parameters:
      p - A visitor specified parameter.
      filter - The visited filter.
      Returns:
      Returns a visitor specified result.

    • visitExtendedFilter

      R visitExtendedFilter(P p, Filter filter)
      Visits a comparison filter.
      Parameters:
      p - A visitor specified parameter.
      filter - The visited filter.
      Returns:
      Returns a visitor specified result.

    • visitGreaterThanFilter

      R visitGreaterThanFilter(P p, GreaterThanFilter filter)
      Visits a greater than filter.
      Parameters:
      p - A visitor specified parameter.
      filter - The visited filter.
      Returns:
      Returns a visitor specified result.

    • visitGreaterThanOrEqualFilter

      R visitGreaterThanOrEqualFilter(P p, GreaterThanOrEqualFilter filter)
      Visits a greater than or equal to filter.
      Parameters:
      p - A visitor specified parameter.
      filter - The visited filter.
      Returns:
      Returns a visitor specified result.

    • visitLessThanFilter

      R visitLessThanFilter(P p, LessThanFilter filter)
      Visits a less than filter.
      Parameters:
      p - A visitor specified parameter.
      filter - The visited filter.
      Returns:
      Returns a visitor specified result.

    • visitLessThanOrEqualFilter

      R visitLessThanOrEqualFilter(P p, LessThanOrEqualFilter filter)
      Visits a less than or equal to filter.
      Parameters:
      p - A visitor specified parameter.
      filter - The visited filter.
      Returns:
      Returns a visitor specified result.

    • visitNotFilter

      R visitNotFilter(P p, NotFilter filter)
      Visits a not filter.
      Parameters:
      p - A visitor specified parameter.
      filter - The visited filter.
      Returns:
      Returns a visitor specified result.

    • visitOrFilter

      R visitOrFilter(P p, OrFilter filter)
      Visits an or filter.

      Implementation note: for the purposes of matching, an empty sub-filters should always evaluate to false.

      Parameters:
      p - A visitor specified parameter.
      filter - The visited filter.
      Returns:
      Returns a visitor specified result.

    • visitStartsWithFilter

      R visitStartsWithFilter(P p, StartsWithFilter filter)
      Visits a starts with filter.
      Parameters:
      p - A visitor specified parameter.
      filter - The visited filter.
      Returns:
      Returns a visitor specified result.

    • visitEndsWithFilter

      R visitEndsWithFilter(P p, EndsWithFilter filter)
      Visits a ends with filter.
      Parameters:
      p - A visitor specified parameter.
      filter - The visited filter.
      Returns:
      Returns a visitor specified result.