/*
 * 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.
 *
 * Other licenses:
 * -----------------------------------------------------------------------------
 * Commercial licenses for this work are available. These replace the above
 * Apache-2.0 license and offer limited warranties, support, maintenance, and
 * commercial database integrations.
 *
 * For more information, please visit: https://www.jooq.org/legal/licensing
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */

package org.jooq;

import static org.jooq.impl.DSL.falseCondition;
import static org.jooq.impl.DSL.keyword;
import static org.jooq.impl.DSL.trueCondition;

import org.jetbrains.annotations.*;


/**
 * An operator used for combining conditions.
 *
 * @author Lukas Eder
 */
public enum Operator {

    /**
     * The and operator
     */
    @NotNull
    @Support
    AND("and"),

    /**
     * The or operator
     */
    @NotNull
    @Support
    OR("or"),

    /**
     * The xor operator
     */
    @NotNull
    @Support
    XOR("xor");

    private final String    sql;
    private final Keyword   keyword;

    private Operator(String sql) {
        this.sql = sql;
        this.keyword = keyword(sql);
    }

    /**
     * A SQL rendition of this operator.
     */
    public final String toSQL() {
        return sql;
    }

    /**
     * A {@link Keyword} rendition of this operator.
     */
    public final Keyword toKeyword() {
        return keyword;
    }

    /**
     * The identity condition for this operator.
     */
    public final Condition identity() {
        return this == AND ? trueCondition() : falseCondition();
    }
}
