com.speedment.runtime.compute.ToBigDecimal Maven / Gradle / Ivy

Go to download
/*
 *
 * Copyright (c) 2006-2020, 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;

import com.speedment.runtime.compute.expression.Expression;
import com.speedment.runtime.compute.expression.ExpressionType;
import com.speedment.runtime.compute.expression.Expressions;
import com.speedment.runtime.compute.internal.expression.AbsUtil;
import com.speedment.runtime.compute.internal.expression.CastUtil;
import com.speedment.runtime.compute.internal.expression.ComposedUtil;
import com.speedment.runtime.compute.internal.expression.MapperUtil;
import com.speedment.runtime.compute.trait.*;

import java.math.BigDecimal;
import java.util.function.Function;
import java.util.function.ToDoubleFunction;
import java.util.function.UnaryOperator;

/**
 * Expression that given an entity returns a non-null {@code BigDecimal} value.
 * This expression can be implemented using a lambda, or it can be a result of
 * another operation. It has additional methods for operating on it.
 *
 * @param  type to extract from
 *
 * @see Function
 *
 * @author Per Minborg
 * @since  3.1.0
 */
@FunctionalInterface
public interface ToBigDecimal
extends Expression,
        Function,
        HasAsInt,
        HasAsLong,
        HasAsDouble,
        HasAbs>,
        HasSign>,
        HasSqrt>,
        HasNegate>,
        HasPow,
        HasPlus,
        HasMinus,
        HasMultiply,
        HasDivide,
        HasMap, ToBigDecimal>,
        HasMapToDouble>,
        HasHash,
        HasCompare,
        HasCompose {

    /**
     * Returns a typed {@code ToBigDecimal} using the provided
     * {@code lambda}.
     *
     * @param  type to extract from
     * @param lambda to convert
     * @return a typed {@code ToBigDecimal} using the provided {@code lambda}
     *
     * @throws NullPointerException if the provided {@code lambda} is
     * {@code null}
     */
    static  ToBigDecimal of(Function lambda) {
        if (lambda instanceof ToBigDecimal) {
            return (ToBigDecimal) lambda;
        } else {
            return lambda::apply;
        }
    }
    
    @Override
    BigDecimal apply(T object);

    @Override
    default ExpressionType expressionType() {
        return ExpressionType.BIG_DECIMAL;
    }

    @Override
    default ToDouble asDouble() {
        return CastUtil.castBigDecimalToDouble(this);
    }

    @Override
    default ToInt asInt() {
        return CastUtil.castBigDecimalToInt(this);
    }

    @Override
    default ToLong asLong() {
        return CastUtil.castBigDecimalToLong(this);
    }

    @Override
    default ToBigDecimal abs() {
        return AbsUtil.absBigDecimal(this);
    }

    @Override
    default ToByte sign() {
        return Expressions.sign(this);
    }

    @Override
    default ToDouble sqrt() {
        return this.asDouble().sqrt();
    }

    @Override
    default ToBigDecimal negate() {
        return Expressions.negate(this);
    }

    @Override
    default ToDouble pow(int power) {
        return Expressions.pow(this.asDouble(), power);
    }

    @Override
    default ToDouble pow(double power) {
        return Expressions.pow(this.asDouble(), power);
    }

    @Override
    default ToDouble pow(ToInt power) {
        return Expressions.pow(this.asDouble(), power);
    }

    @Override
    default ToDouble pow(ToDouble power) {
        return Expressions.pow(this.asDouble(), power);
    }

    @Override
    default ToDouble plus(byte other) {
        return Expressions.plus(this.asDouble(), other);
    }

    @Override
    default ToDouble plus(ToByte other) {
        return Expressions.plus(this.asDouble(), other.asInt());
    }

    @Override
    default ToDouble plus(int other) {
        return Expressions.plus(this.asDouble(), other);
    }

    @Override
    default ToDouble plus(ToInt other) {
        return Expressions.plus(this.asDouble(), other);
    }

    @Override
    default ToDouble plus(long other) {
        return Expressions.plus(this.asDouble(), other);
    }

    @Override
    default ToDouble plus(ToLong other) {
        return Expressions.plus(this.asDouble(), other);
    }

    @Override
    default ToDouble plus(double other) {
        return Expressions.plus(this.asDouble(), other);
    }

    @Override
    default ToDouble plus(ToDouble other) {
        return Expressions.plus(this.asDouble(), other);
    }

    @Override
    default ToDouble minus(byte other) {
        return Expressions.minus(this.asDouble(), other);
    }

    @Override
    default ToDouble minus(ToByte other) {
        return Expressions.minus(this.asDouble(), other.asInt());
    }

    @Override
    default ToDouble minus(int other) {
        return Expressions.minus(this.asDouble(), other);
    }

    @Override
    default ToDouble minus(ToInt other) {
        return Expressions.minus(this.asDouble(), other);
    }

    @Override
    default ToDouble minus(long other) {
        return Expressions.minus(this.asDouble(), other);
    }

    @Override
    default ToDouble minus(ToLong other) {
        return Expressions.minus(this.asDouble(), other);
    }

    @Override
    default ToDouble minus(double other) {
        return Expressions.minus(this.asDouble(), other);
    }

    @Override
    default ToDouble minus(ToDouble other) {
        return Expressions.minus(this.asDouble(), other);
    }

    @Override
    default ToDouble multiply(byte other) {
        return Expressions.multiply(this.asDouble(), other);
    }

    @Override
    default ToDouble multiply(ToByte other) {
        return Expressions.multiply(this.asDouble(), other.asInt());
    }

    @Override
    default ToDouble multiply(int other) {
        return Expressions.multiply(this.asDouble(), other);
    }

    @Override
    default ToDouble multiply(ToInt other) {
        return Expressions.multiply(this.asDouble(), other);
    }

    @Override
    default ToDouble multiply(long other) {
        return Expressions.multiply(this.asDouble(), other);
    }

    @Override
    default ToDouble multiply(ToLong other) {
        return Expressions.multiply(this.asDouble(), other);
    }

    @Override
    default ToDouble multiply(double other) {
        return Expressions.multiply(this.asDouble(), other);
    }

    @Override
    default ToDouble multiply(ToDouble other) {
        return Expressions.multiply(this.asDouble(), other);
    }

    @Override
    default ToDouble divide(int divisor) {
        return Expressions.divide(this.asDouble(), divisor);
    }

    @Override
    default ToDouble divide(ToInt divisor) {
        return Expressions.divide(this.asDouble(), divisor);
    }

    @Override
    default ToDouble divide(long divisor) {
        return Expressions.divide(this.asDouble(), divisor);
    }

    @Override
    default ToDouble divide(ToLong divisor) {
        return Expressions.divide(this.asDouble(), divisor);
    }

    @Override
    default ToDouble divide(double divisor) {
        return Expressions.divide(this.asDouble(), divisor);
    }

    @Override
    default ToDouble divide(ToDouble divisor) {
        return Expressions.divide(this.asDouble(), divisor);
    }

    @Override
    default ToBigDecimal map(UnaryOperator mapper) {
        return MapperUtil.mapBigDecimal(this, mapper);
    }

    @Override
    default ToDouble mapToDouble(ToDoubleFunction mapper) {
        return MapperUtil.mapBigDecimalToDouble(this, mapper);
    }

    @Override
    default long hash(T object) {
        return apply(object).hashCode();
    }

    @Override
    default int compare(T first, T second) {
        return apply(first).compareTo(apply(second));
    }

    @Override
    default  ToBigDecimalNullable compose(Function before) {
        @SuppressWarnings("unchecked")
        final Function casted = (Function) before;
        return ComposedUtil.composeToBigDecimal(casted, this);
    }
}