com.speedment.runtime.compute.trait.HasMultiply Maven / Gradle / Ivy
Show all versions of runtime-deploy Show documentation
/**
*
* 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.trait;
import com.speedment.runtime.compute.ToByte;
import com.speedment.runtime.compute.ToDouble;
import com.speedment.runtime.compute.ToInt;
import com.speedment.runtime.compute.ToLong;
/**
* Trait that describes an expression that has several
* {@link #multiply(int)}-methods for generating new expressions for the product
* of this value and something else.
*
* @param the input type
*
* @author Emil Forslund
* @since 3.1.0
*/
public interface HasMultiply {
/**
* Creates and returns an expression that returns the product of the result
* from the current expression and the other factor. For an example, if the
* result of the current expression was {@code 9} and the factor was set to
* {@code 3}, then the result of the returned expression would be {@code
* 27}.
*
* If this expression is nullable and the result was {@code null}, then the
* result of the returned expression will also be {@code null}.
*
* @param other the other factor used for the multiplication
* @return the new expression
*/
HasMultiply multiply(byte other);
/**
* Creates and returns an expression that returns the product of the result
* from the current expression and the other factor. For an example, if the
* result of the current expression was {@code 9} and the factor was set to
* {@code 3}, then the result of the returned expression would be {@code
* 27}.
*
* If this expression is nullable and the result was {@code null}, then the
* result of the returned expression will also be {@code null}.
*
* @param other the other factor used for the multiplication
* @return the new expression
*/
HasMultiply multiply(ToByte other);
/**
* Creates and returns an expression that returns the product of the result
* from the current expression and the other factor. For an example, if the
* result of the current expression was {@code 9} and the factor was set to
* {@code 3}, then the result of the returned expression would be {@code
* 27}.
*
* If this expression is nullable and the result was {@code null}, then the
* result of the returned expression will also be {@code null}.
*
* @param other the other factor used for the multiplication
* @return the new expression
*/
HasMultiply multiply(int other);
/**
* Creates and returns an expression that returns the product of the result
* from the current expression and the other factor. For an example, if the
* result of the current expression was {@code 9} and the factor was set to
* {@code 3}, then the result of the returned expression would be {@code
* 27}.
*
* If this expression is nullable and the result was {@code null}, then the
* result of the returned expression will also be {@code null}.
*
* @param other the other factor used for the multiplication
* @return the new expression
*/
HasMultiply multiply(ToInt other);
/**
* Creates and returns an expression that returns the product of the result
* from the current expression and the other factor. For an example, if the
* result of the current expression was {@code 9} and the factor was set to
* {@code 3}, then the result of the returned expression would be {@code
* 27}.
*
* If this expression is nullable and the result was {@code null}, then the
* result of the returned expression will also be {@code null}.
*
* @param other the other factor used for the multiplication
* @return the new expression
*/
HasMultiply multiply(long other);
/**
* Creates and returns an expression that returns the product of the result
* from the current expression and the other factor. For an example, if the
* result of the current expression was {@code 9} and the factor was set to
* {@code 3}, then the result of the returned expression would be {@code
* 27}.
*
* If this expression is nullable and the result was {@code null}, then the
* result of the returned expression will also be {@code null}.
*
* @param other the other factor used for the multiplication
* @return the new expression
*/
HasMultiply multiply(ToLong other);
/**
* Creates and returns an expression that returns the product of the result
* from the current expression and the other factor. For an example, if the
* result of the current expression was {@code 9} and the factor was set to
* {@code 3}, then the result of the returned expression would be {@code
* 27}.
*
* If this expression is nullable and the result was {@code null}, then the
* result of the returned expression will also be {@code null}.
*
* @param other the other factor used for the multiplication
* @return the new expression
*/
ToDouble multiply(double other);
/**
* Creates and returns an expression that returns the product of the result
* from the current expression and the other factor. For an example, if the
* result of the current expression was {@code 9} and the factor was set to
* {@code 3}, then the result of the returned expression would be {@code
* 27}.
*
* If this expression is nullable and the result was {@code null}, then the
* result of the returned expression will also be {@code null}.
*
* @param other the other factor used for the multiplication
* @return the new expression
*/
ToDouble multiply(ToDouble other);
}