org.mybatis.dynamic.sql.where.condition.IsIn Maven / Gradle / Ivy

Go to download
/*
 *    Copyright ${license.git.copyrightYears} the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.mybatis.dynamic.sql.where.condition;

import static org.mybatis.dynamic.sql.util.StringUtilities.spaceAfter;

import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.function.BiFunction;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.function.UnaryOperator;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import org.mybatis.dynamic.sql.AbstractListValueCondition;
import org.mybatis.dynamic.sql.Callback;

public class IsIn extends AbstractListValueCondition {
    private static final IsIn EMPTY = new IsIn<>(Collections.emptyList());

    public static  IsIn empty() {
        @SuppressWarnings("unchecked")
        IsIn t = (IsIn) EMPTY;
        return t;
    }

    protected IsIn(Collection values) {
        super(values);
    }

    protected IsIn(Collection values, Callback emptyCallback) {
        super(values, emptyCallback);
    }

    @Override
    public String renderCondition(String columnName, Stream placeholders) {
        return spaceAfter(columnName)
                + placeholders.collect(Collectors.joining(",", "in (", ")")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
    }

    @Override
    public IsIn withListEmptyCallback(Callback callback) {
        return new IsIn<>(values, callback);
    }

    /**
     * This method allows you to modify the condition's values before they are placed into the parameter map.
     * For example, you could filter nulls, or trim strings, etc. This process will run before final rendering of SQL.
     * If you filter values out of the stream, then final condition will not reference those values. If you filter all
     * values out of the stream, then the condition will not render.
     *
     * @deprecated replaced by {@link IsIn#map(Function)} and {@link IsIn#filter(Predicate)}
     * @param valueStreamTransformer a UnaryOperator that will transform the value stream before
     *     the values are placed in the parameter map
     * @return new condition with the specified transformer
     */
    @Deprecated
    public IsIn then(UnaryOperator> valueStreamTransformer) {
        List mapped = valueStreamTransformer.apply(values.stream())
                .collect(Collectors.toList());
        return new IsIn<>(mapped, emptyCallback);
    }

    @Override
    public IsIn filter(Predicate predicate) {
        return filterSupport(predicate, IsIn::new, this, IsIn::empty);
    }

    /**
     * If renderable, apply the mapping to each value in the list return a new condition with the mapped values.
     *     Else return a condition that will not render (this).
     *
     * @param mapper a mapping function to apply to the values, if renderable
     * @param  type of the new condition
     * @return a new condition with mapped values if renderable, otherwise a condition
     *     that will not render.
     */
    public  IsIn map(Function mapper) {
        BiFunction, Callback, IsIn> constructor = IsIn::new;
        return mapSupport(mapper, constructor, IsIn::empty);
    }

    @SafeVarargs
    public static  IsIn of(T... values) {
        return of(Arrays.asList(values));
    }

    public static  IsIn of(Collection values) {
        return new IsIn<>(values);
    }
}