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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of runtime-compute Show documentation
Functional interfaces and utility class used to express computations on Speedment entities.
There is a newer version: 3.2.10
/**
 *
 * 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;

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.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.util.function.Function;
import java.util.function.LongToDoubleFunction;
import java.util.function.LongUnaryOperator;
import java.util.function.ToLongFunction;

/**
 * Expression that given an entity returns a {@code long} 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 ToLongFunction
 *
 * @author Emil Forslund
 * @since 3.1.0
 */
@FunctionalInterface
public interface ToLong
extends Expression,
        ToLongFunction,
        HasAsDouble,
        HasAsInt,
        HasAsLong,
        HasAbs>,
        HasSign>,
        HasSqrt>,
        HasNegate>,
        HasPow,
        HasPlus,
        HasMinus,
        HasMultiply,
        HasDivide,
        HasMap>,
        HasMapToDouble,
        HasHash,
        HasCompare,
        HasCompose {

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

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

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

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

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

    @Override
    default ToDouble mapToDouble(LongToDoubleFunction operator) {
        return MapperUtil.mapLongToDouble(this, operator);
    }

    @Override
    default ToLong map(LongUnaryOperator operator) {
        return MapperUtil.mapLong(this, operator);
    }

    @Override
    default ToLong abs() {
        return Expressions.abs(this);
    }

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

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

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

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

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

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

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

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

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

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

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

    @Override
    default ToLong plus(ToLong other) {
        return Expressions.plus(this, 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 ToLong minus(byte other) {
        return Expressions.minus(this, other);
    }

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

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

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

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

    @Override
    default ToLong minus(ToLong other) {
        return Expressions.minus(this, 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 ToLong multiply(byte other) {
        return Expressions.multiply(this, other);
    }

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

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

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

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

    @Override
    default ToLong multiply(ToLong other) {
        return Expressions.multiply(this, 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, divisor);
    }

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

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

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

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

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

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

    @Override
    default long hash(T object) {
        final long l = applyAsLong(object);
        return (int) (l ^ (l >>> 32));
    }

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

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