com.speedment.runtime.compute.expression.UnaryExpression 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 a single operand that implements
 * {@link Expression}.
 * 
 * Equality is determined by looking at {@link #inner()} and
 * {@link #operator()}.
 *
 * @param       the input entity type
 * @param   the type of the inner expression
 *
 * @author Emil Forslund
 * @since  3.1.0
 */
public interface UnaryExpression>
extends Expression {

    /**
     * The inner expression that this wraps and applies a unary operator to.
     *
     * @return  the inner expression
     */
    INNER inner();

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

    /**
     * The unary expression operator type.
     */
    enum Operator {

        /**
         * This expression is the absolute value of the result from the inner
         * expression. That is, the negation sign is ignored, returning only
         * positive values.
         */
        ABS,

        /**
         * This expression is the result of the inner expression casted to a
         * different type
         */
        CAST,

        /**
         * This expression is the negation of the inner expression. That is, the
         * negation sign is flipped.
         */
        NEGATE,

        /**
         * The result of this expression is {@code 0} if the result of the inner
         * expression is {@code 0}, {@code 1} of the inner returned something
         * positive and {@code -1} if the inner returned something negative.
         */
        SIGN,

        /**
         * The result of this expression is the positive square root of the
         * result of the inner expression.
         */
        SQRT
    }
}