Package org.dmfs.jems2.function

Class Clamping<T extends Comparable<T>>

java.lang.Object

org.dmfs.jems2.function.Clamping<T>

All Implemented Interfaces:

FragileFunction<T,T,RuntimeException>, Function<T,T>, ThrowingFunction<T,T>

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

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

Constructor Summary

Constructors

Constructor	Description
Clamping(T minValue, T maxValue)

Method Summary

Modifier and Type	Method	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 Details

Clamping

public Clamping(T minValue,
 T maxValue)

Method Details

value

public T value(T argument)

Description copied from interface: Function

Returns the value of this function at the given argument.

Specified by:

value in interface FragileFunction<T extends Comparable<T>,T extends Comparable<T>,RuntimeException>

Specified by:

value in interface Function<T extends Comparable<T>,T extends Comparable<T>>

Specified by:

value in interface ThrowingFunction<T extends Comparable<T>,T extends Comparable<T>>