Package me.datafox.dfxengine.values.api.operation

Interface Operation

All Superinterfaces:

BiFunction<Numeral,Numeral[],Numeral>

All Known Subinterfaces:

DualParameterOperation, SingleParameterOperation, SourceOperation

All Known Implementing Classes:

MappingOperationChain, OperationChain

public interface Operation
extends BiFunction<Numeral,Numeral[],Numeral>

An Operation represents a math operation that has one input and an arbitrary number of parameters. When used with Value.apply(Operation, MathContext, Numeral...) or any of the other apply methods in Value and ValueMap, the Value is used as the input.

Method Summary

Modifier and Type	Method	Description
Numeral	apply(Numeral source, Numeral... parameters)
int	getParameterCount()

Methods inherited from interface java.util.function.BiFunction

andThen

Method Details

getParameterCount

int getParameterCount()

Returns:

the amount of parameters this operation expects

apply

Numeral apply(Numeral source,
 Numeral... parameters)

Specified by:

apply in interface BiFunction<Numeral,Numeral[],Numeral>

Parameters:

source - source Numeral for this operation

parameters - parameter Numerals for this operation

Returns:

resulting Numeral of this operation

Throws:

IllegalArgumentException - if the amount of parameters is not equal to getParameterCount()