org.seedstack.business.specification.dsl.StringOptionPicker 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;

/**
 * An element of the {@link SpecificationBuilder} DSL to pick the options for a {@link
 * String}-specific specification.
 *
 * @param  the type of the object the specification applies to.
 * @param  the type of the selector.
 */
public interface StringOptionPicker extends OperatorPicker {

    /**
     * Specifies that the value should trimmed of leading and trailing whitespaces before comparison.
     *
     * @return the next operation of the builder DSL, allowing to specify more options or compose a
     * new specification.
     */
    StringOptionPicker trimming();

    /**
     * Specifies that the value should be trimmed of leading whitespace before comparison.
     *
     * @return the next operation of the builder DSL, allowing to specify more options or compose a
     * new specification.
     */
    StringOptionPicker trimmingLead();

    /**
     * Specifies that the value should be trimmed of trailing whitespace before comparison.
     *
     * @return the next operation of the builder DSL, allowing to specify more options or compose a
     * new specification.
     */
    StringOptionPicker trimmingTail();

    /**
     * Specifies that the comparison should be done ignoring case.
     *
     * @return the next operation of the builder DSL, allowing to specify more options or compose a
     * new specification.
     */
    StringOptionPicker ignoringCase();
}