org.dmfs.jems.function.decorators

Class Clamping<T extends java.lang.Comparable<T>>

java.lang.Object

org.dmfs.jems.function.decorators.Clamping<T>

All Implemented Interfaces:

FragileFunction<T,T,java.lang.RuntimeException>, Function<T,T>

public final class Clamping<T extends java.lang.Comparable<T>>
extends java.lang.Object
implements Function<T,T>

Function decorator that 'clamps' the value between the provided min and max values.

Constructor Summary

Constructors

Constructor and Description
Clamping(T minValue, T maxValue)
Clamping(T minValue, T maxValue, Function<T,T> originalFunction)

Method Summary

Modifier and Type	Method and Description
T	value(T argument) Returns the value of this function at the given argument.

Methods inherited from class java.lang.Object

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

Constructor Detail

Clamping

public Clamping(T minValue,
                T maxValue,
                Function<T,T> originalFunction)

Clamping

public Clamping(T minValue,
                T maxValue)

Method Detail

value

public T value(T argument)

Description copied from interface: FragileFunction

Returns the value of this function at the given argument.

Specified by:

value in interface FragileFunction<T extends java.lang.Comparable<T>,T extends java.lang.Comparable<T>,java.lang.RuntimeException>

Parameters:

argument - The argument of the function.

Returns:

The value of the function.