FilterVisitor.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2014 ForgeRock AS. All Rights Reserved
 *
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at
 * http://forgerock.org/license/CDDLv1.0.html
 * See the License for the specific language governing
 * permission and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at http://forgerock.org/license/CDDLv1.0.html
 * If applicable, add the following below the CDDL Header,
 * with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 */

package org.identityconnectors.framework.common.objects.filter;

/**
 * A visitor of {@code Filter}s, in the style of the visitor design pattern.
 * <p>
 * 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.
 *
 * @param <R>
 *            The return type of this visitor's methods. Use
 *            {@link java.lang.Void} for visitors that do not need to return
 *            results.
 * @param <P>
 *            The type of the additional parameter to this visitor's methods.
 *            Use {@link java.lang.Void} for visitors that do not need an
 *            additional parameter.
 * @since 1.4
 */
public interface FilterVisitor<R, P> {

    /**
     * Visits an {@code and} filter.
     * <p>
     * <b>Implementation note</b>: for the purposes of matching, an empty
     * sub-filters should always evaluate to {@code true}.
     *
     * @param p
     *            A visitor specified parameter.
     * @param filter
     *            The visited filter.
     * @return Returns a visitor specified result.
     */
    R visitAndFilter(P p, AndFilter filter);

    /**
     * Visits a {@code contains} filter.
     *
     * @param p
     *            A visitor specified parameter.
     * @param filter
     *            The visited filter.
     * @return Returns a visitor specified result.
     */
    R visitContainsFilter(P p, ContainsFilter filter);

    /**
     * Visits a {@code containsAll} filter.
     *
     * @param p
     *            A visitor specified parameter.
     * @param filter
     *            The visited filter.
     * @return Returns a visitor specified result.
     */
    R visitContainsAllValuesFilter(P p, ContainsAllValuesFilter filter);

    /**
     * Visits a {@code equality} filter.
     *
     * @param p
     *            A visitor specified parameter.
     * @param filter
     *            The visited filter.
     * @return Returns a visitor specified result.
     */
    R visitEqualsFilter(P p, EqualsFilter filter);

    /**
     * Visits a {@code comparison} filter.
     *
     * @param p
     *            A visitor specified parameter.
     * @param filter
     *            The visited filter.
     * @return Returns a visitor specified result.
     */
    R visitExtendedFilter(P p, Filter filter);

    /**
     * Visits a {@code greater than} filter.
     *
     * @param p
     *            A visitor specified parameter.
     * @param filter
     *            The visited filter.
     * @return Returns a visitor specified result.
     */
    R visitGreaterThanFilter(P p, GreaterThanFilter filter);

    /**
     * Visits a {@code greater than or equal to} filter.
     *
     * @param p
     *            A visitor specified parameter.
     * @param filter
     *            The visited filter.
     * @return Returns a visitor specified result.
     */
    R visitGreaterThanOrEqualFilter(P p, GreaterThanOrEqualFilter filter);

    /**
     * Visits a {@code less than} filter.
     *
     * @param p
     *            A visitor specified parameter.
     * @param filter
     *            The visited filter.
     * @return Returns a visitor specified result.
     */
    R visitLessThanFilter(P p, LessThanFilter filter);

    /**
     * Visits a {@code less than or equal to} filter.
     *
     * @param p
     *            A visitor specified parameter.
     * @param filter
     *            The visited filter.
     * @return Returns a visitor specified result.
     */
    R visitLessThanOrEqualFilter(P p, LessThanOrEqualFilter filter);

    /**
     * Visits a {@code not} filter.
     *
     * @param p
     *            A visitor specified parameter.
     * @param filter
     *            The visited filter.
     * @return Returns a visitor specified result.
     */
    R visitNotFilter(P p, NotFilter filter);

    /**
     * Visits an {@code or} filter.
     * <p>
     * <b>Implementation note</b>: for the purposes of matching, an empty
     * sub-filters should always evaluate to {@code false}.
     *
     * @param p
     *            A visitor specified parameter.
     * @param filter
     *            The visited filter.
     * @return Returns a visitor specified result.
     */
    R visitOrFilter(P p, OrFilter filter);

    /**
     * Visits a {@code starts with} filter.
     *
     * @param p
     *            A visitor specified parameter.
     * @param filter
     *            The visited filter.
     * @return Returns a visitor specified result.
     */
    R visitStartsWithFilter(P p, StartsWithFilter filter);

    /**
     * Visits a {@code ends with} filter.
     *
     * @param p
     *            A visitor specified parameter.
     * @param filter
     *            The visited filter.
     * @return Returns a visitor specified result.
     */
    R visitEndsWithFilter(P p, EndsWithFilter filter);

}