org.mybatis.dynamic.sql.configuration.StatementConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mybatis-dynamic-sql Show documentation

MyBatis framework for generating dynamic SQL

The newest version!

/*
 *    Copyright 2016-2024 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
 *
 *       https://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.configuration;

import org.mybatis.dynamic.sql.exception.NonRenderingWhereClauseException;

/**
 * This class can be used to change some behaviors of the framework. Every configurable statement
 * contains a unique instance of this class, so changes here will only impact a single statement.
 * If you intend to change the behavior for all statements, use the {@link GlobalConfiguration}.
 * Initial values for this class in each statement are set from the {@link GlobalConfiguration}.
 * Configurable behaviors are detailed below:
 *
 * 
 *     nonRenderingWhereClauseAllowed
 *     If false (default), the framework will throw a {@link NonRenderingWhereClauseException}
 *         if a where clause is specified in the statement, but it fails to render because all
 *         optional conditions do not render. For example, if an "in" condition specifies an
 *         empty list of values. If no criteria are specified in a where clause, the framework
 *         assumes that no where clause was intended and will not throw an exception.
 *     
 * 
 *
 * @see GlobalConfiguration
 *
 * @since 1.4.1
 *
 * @author Jeff Butler
 */
public class StatementConfiguration {
    private boolean isNonRenderingWhereClauseAllowed =
            GlobalContext.getConfiguration().isIsNonRenderingWhereClauseAllowed();

    public boolean isNonRenderingWhereClauseAllowed() {
        return isNonRenderingWhereClauseAllowed;
    }

    public StatementConfiguration setNonRenderingWhereClauseAllowed(boolean nonRenderingWhereClauseAllowed) {
        isNonRenderingWhereClauseAllowed = nonRenderingWhereClauseAllowed;
        return this;
    }
}