Package com.singularsys.extensions.stream

Class StreamTerminalNaryBinaryFunction

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.UnaryFunction

com.singularsys.extensions.stream.StreamTerminalNaryBinaryFunction

All Implemented Interfaces:

ZeroLengthBehaviourI, ZeroLengthBehaviourI.DefaultZeroLengthBehaviourI, JepComponent, PostfixMathCommandI, Serializable

public class StreamTerminalNaryBinaryFunction
extends UnaryFunction
implements JepComponent, ZeroLengthBehaviourI.DefaultZeroLengthBehaviourI

Terminal function that reduces a stream to a single value using an NaryBinaryFunction. It can be set up with either an initial value, in which case the reduction is performed using the reduce method of the stream, or without an initial value, in which case the reduction is performed using the reduce method of the stream.

By default, if the stream is empty, an exception is thrown, but the behaviour can be configured using the methods of the ZeroLengthBehaviourI interface.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.singularsys.jep.functions.UnaryFunction

UnaryFunction.FunctionWithException<T>

Nested classes/interfaces inherited from interface com.singularsys.jep.functions.ZeroLengthBehaviourI

ZeroLengthBehaviourI.DefaultZeroLengthBehaviourI, ZeroLengthBehaviourI.ZeroLengthErrorBehaviour, ZeroLengthBehaviourI.ZeroLengthHelper

Field Summary

Fields inherited from class com.singularsys.jep.functions.PostfixMathCommand

curNumberOfParameters, description, name, NaN, numberOfParameters

Constructor Summary

Constructors

Constructor	Description
StreamTerminalNaryBinaryFunction(NaryBinaryFunction inner, Object initial)

Method Summary

Modifier and Type	Method	Description
Object	eval(Object r)	Evaluate the function
String	getDescription()	Return a description of the function from the properties file.
JepComponent	getLightWeightInstance()	Gets a light-weight instance suitable for using in multiple threads.
ZeroLengthBehaviourI	getZeroLengthHelper()	Gets the helper class which implements the zero length behaviour.
void	init(Jep jep)	Initialize the component.

Methods inherited from class com.singularsys.jep.functions.UnaryFunction

instanceOf, instanceOf, instanceOf, instanceOf, run

Methods inherited from class com.singularsys.jep.functions.PostfixMathCommand

asArray, asBool, asDouble, asInt, asLong, asStrictInt, asString, asType, checkNumberOfParameters, getDescription, getDescriptionWithType, getName, getNumberOfParameters, setCurNumberOfParameters, setDescription, setName, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.singularsys.jep.functions.ZeroLengthBehaviourI

getErrorMessage, getValueOrException, zeroLengthResultOrException

Methods inherited from interface com.singularsys.jep.functions.ZeroLengthBehaviourI.DefaultZeroLengthBehaviourI

getZeroLengthErrorBehaviour, getZeroLengthValue, setZeroLengthErrorBehaviour, setZeroLengthValue

Constructor Details

StreamTerminalNaryBinaryFunction

public StreamTerminalNaryBinaryFunction(NaryBinaryFunction inner,
 Object initial)

Method Details

eval

public Object eval(Object r)
            throws EvaluationException

Description copied from class: UnaryFunction

Evaluate the function

Specified by:

eval in class UnaryFunction

Parameters:

r - the single argument passed in

Returns:

the result of the function

Throws:

EvaluationException - on error

init

public void init(Jep jep)

Description copied from interface: JepComponent

Initialize the component. This method is called whenever a component is added to Jep. Hence, it allows components to keep track of the other components they may rely on.

Specified by:

init in interface JepComponent

Parameters:

jep - the current Jep instance

getLightWeightInstance

public JepComponent getLightWeightInstance()

Description copied from interface: JepComponent

Gets a light-weight instance suitable for using in multiple threads.

Specified by:

getLightWeightInstance in interface JepComponent

Returns:

either a new instance, null or 'this'.

getZeroLengthHelper

public ZeroLengthBehaviourI getZeroLengthHelper()

Description copied from interface: ZeroLengthBehaviourI.DefaultZeroLengthBehaviourI

Gets the helper class which implements the zero length behaviour. The standard implementation is:

ZeroLengthHelper zeroLengthHelper = new ZeroLengthHelper();
@Override
public ZeroLengthBehaviourI getZeroLengthHelper() {
    return zeroLengthHelper;
}

Specified by:

getZeroLengthHelper in interface ZeroLengthBehaviourI.DefaultZeroLengthBehaviourI

Returns:

the helper class

getDescription

public String getDescription()

Description copied from class: PostfixMathCommand

Return a description of the function from the properties file. The property name is the class name followed by ".description". The property is found using the JepMessages class, which can be configured to add additional properties files. If PostfixMathCommand.setDescription(String) has been called, return the description set by that method instead.

Specified by:

getDescription in interface PostfixMathCommandI

Overrides:

getDescription in class PostfixMathCommand

Returns:

the description of the function