org.seedstack.business.specification.dsl.SpecificationPicker Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2013-2024, The SeedStack authors 
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
package org.seedstack.business.specification.dsl;

import org.seedstack.business.specification.Specification;

/**
 * An element of the {@link SpecificationBuilder} DSL to pick the specification that will apply to
 * the current selection.
 *
 * @param  the type of the object the specification applies to.
 * @param  the type of the selector.
 */
public interface SpecificationPicker {
    /**
     * Negates the specification that will be picked.
     *
     * @return the next operation of the builder DSL, allowing to pick the negated specification.
     */
    SpecificationPicker not();

    /**
     * Picks a custom specification.
     *
     * @param specification the custom specification.
     * @return the next operation of the builder DSL, allowing to combine this specification with
     * another one.
     */
    OperatorPicker satisfying(Specification specification);

    /**
     * Picks a {@link String}-specific matching specification that will be satisfied if the current
     * selection matches the specified pattern. A pattern can contain:  '?' characters which
     * match any character.
 '*' characters which match any (possibly empty) sequence of
     * characters.
 
     *
     * @param pattern the pattern to match.
     * @return the next operation of the builder DSL, allowing to pick the string matching options.
     */
    StringOptionPicker matching(String pattern);

    /**
     * Picks a {@link String}-specific equality specification that will be satisfied if the current
     * selection equals to the specified value.
     *
     * @param value the value to be equal to.
     * @return the next operation of the builder DSL, allowing to pick the string equality options.
     */
    StringOptionPicker equalTo(String value);

    /**
     * Picks a general purpose equality specification that will be satisfied if the current selection
     * equals to the specified value.
     *
     * @param value the value to be equal to.
     * @param    the type of the value.
     * @return the next operation of the builder DSL, allowing to combine this specification with
     * another one.
     */
     OperatorPicker equalTo(V value);

    /**
     * Picks a greater than specification that will be satisfied if the current selection is strictly
     * greater than the specified value.
     *
     * @param value the value to be greater than.
     * @param    the type of the value.
     * @return the next operation of the builder DSL, allowing to combine this specification with
     * another one.
     */
    > OperatorPicker greaterThan(V value);

    /**
     * Picks a greater than or equal to specification that will be satisfied if the current selection
     * is greater than or equal to the specified value.
     *
     * @param value the value to be greater than or equal to.
     * @param    the type of the value.
     * @return the next operation of the builder DSL, allowing to combine this specification with
     * another one.
     */
    > OperatorPicker greaterThanOrEqualTo(V value);

    /**
     * Picks a less than specification that will be satisfied if the current selection is strictly
     * less than the specified value.
     *
     * @param value the value to be less than.
     * @param    the type of the value.
     * @return the next operation of the builder DSL, allowing to combine this specification with
     * another one.
     */
    > OperatorPicker lessThan(V value);

    /**
     * Picks a less than or equal to specification that will be satisfied if the current selection is
     * less than or equal to the specified value.
     *
     * @param value the value to be less than or equal to.
     * @param    the type of the value.
     * @return the next operation of the builder DSL, allowing to combine this specification with
     * another one.
     */
    > OperatorPicker lessThanOrEqualTo(V value);

    /**
     * Picks a between specification that will be satisfied if the current selection is strictly
     * greater than and strictly less than to the specified value.
     *
     * @param leftValue  the value to be greater than.
     * @param rightValue the value to be less than.
     * @param         the type of the value.
     * @return the next operation of the builder DSL, allowing to combine this specification with
     * another one.
     */
    > OperatorPicker between(V leftValue, V rightValue);

    /**
     * Picks a between specification that will be satisfied if the current selection is (strictly or
     * not) greater than and (strictly or not) less than to the specified value.
     *
     * @param leftValue      the value to be greater than (or equal to if leftInclusive is true).
     * @param rightValue     the value to be less than  (or equal to if rightInclusive is true).
     * @param leftInclusive  if true, the leftValue argument will be included in the interval,
     *                       otherwise it will be excluded.
     * @param rightInclusive if true, the rightValue argument will be included in the interval,
     *                       otherwise it will be excluded.
     * @param             the type of the value.
     * @return the next operation of the builder DSL, allowing to combine this specification with
     * another one.
     */
    > OperatorPicker between(V leftValue, V rightValue, boolean leftInclusive,
            boolean rightInclusive);
}