kotlin-stdlib/kotlin.ranges/coerceAtLeast

coerceAtLeast

fun <T : Comparable<T>> T.coerceAtLeast(minimumValue: T): T(source)

Ensures that this value is not less than the specified minimumValue.

Since Kotlin

1.0

Return

this value if it's greater than or equal to the minimumValue or the minimumValue otherwise.

Samples

import java.time.DayOfWeek
import kotlin.test.assertFailsWith

fun main() { 
   //sampleStart 
   println(DayOfWeek.WEDNESDAY.coerceAtLeast(DayOfWeek.MONDAY)) // WEDNESDAY
println(DayOfWeek.WEDNESDAY.coerceAtLeast(DayOfWeek.FRIDAY)) // FRIDAY 
   //sampleEnd
}
xxxxxxxxxx
 
println(DayOfWeek.WEDNESDAY.coerceAtLeast(DayOfWeek.MONDAY)) // WEDNESDAY
println(DayOfWeek.WEDNESDAY.coerceAtLeast(DayOfWeek.FRIDAY)) // FRIDAY 
Open in Playground →
Target: JVMRunning on v.2.1.20

fun Byte.coerceAtLeast(minimumValue: Byte): Byte(source)

fun Short.coerceAtLeast(minimumValue: Short): Short(source)

fun Int.coerceAtLeast(minimumValue: Int): Int(source)

fun Long.coerceAtLeast(minimumValue: Long): Long(source)

fun Float.coerceAtLeast(minimumValue: Float): Float(source)

fun Double.coerceAtLeast(minimumValue: Double): Double(source)

Ensures that this value is not less than the specified minimumValue.

Since Kotlin

1.0

Return

this value if it's greater than or equal to the minimumValue or the minimumValue otherwise.

Samples

import java.time.DayOfWeek
import kotlin.test.assertFailsWith

fun main() { 
   //sampleStart 
   println(10.coerceAtLeast(5)) // 10
println(10.coerceAtLeast(20)) // 20 
   //sampleEnd
}
xxxxxxxxxx
 
println(10.coerceAtLeast(5)) // 10
println(10.coerceAtLeast(20)) // 20 
Open in Playground →
Target: JVMRunning on v.2.1.20

Thanks for your feedback!

Was this page helpful?