com.speedment.runtime.compute.expression.BinaryExpression Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tool-deploy Show documentation

A Speedment bundle that shades all dependencies into one jar. This is useful when deploying an application on a server.

The newest version!

/*
 *
 * Copyright (c) 2006-2019, Speedment, Inc. All Rights Reserved.
 *
 * 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 com.speedment.runtime.compute.expression;

/**
 * An {@link Expression} that has two operands, both are implementations of
 * {@link Expression}.
 * 
 * Equality is determined by looking at {@link #first()},
 * {@link #second()} and {@link #operator()}.
 *
 * @param        the input entity type
 * @param    the type of the first operand, an expression
 * @param   the type of the second operand, an expression
 *
 * @author Emil Forslund
 * @since  3.1.0
 */
public interface BinaryExpression<
    T,
    FIRST extends Expression,
    SECOND extends Expression
> extends Expression {

    /**
     * Returns the first operand, an inner expression.
     *
     * @return  the first operand
     */
    FIRST first();

    /**
     * Returns the second operand, an inner expression.
     *
     * @return  the second operand
     */
    SECOND second();

    /**
     * Returns the binary operator that this expression represents.
     *
     * @return  the operator
     */
    Operator operator();

    /**
     * Operator types that could be returned by {@link #operator()}.
     */
    enum Operator {
        /**
         * The result of the first operand raised to the power of the second.
         */
        POW,

        /**
         * The result of the first operand added to the second (addition).
         */
        PLUS,

        /**
         * The result of the first operand minus the second (subtraction).
         */
        MINUS,

        /**
         * The result of the first operand multiplied by the second
         * (multiplication).
         */
        MULTIPLY,

        /**
         * The result of the first operand divided by the second (division).
         */
        DIVIDE
    }
}