core/com.composables.core.androidx.annotation/FloatRange

FloatRange

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.ANNOTATION_CLASS])

annotation class FloatRange(val from: Double = Double.NEGATIVE_INFINITY, val to: Double = Double.POSITIVE_INFINITY, val fromInclusive: Boolean = true, val toInclusive: Boolean = true)

Denotes that the annotated element should be a float or double in the given range

Example:

@FloatRange(from=0.0,to=1.0)
public float getAlpha() {
    ...
}

Properties

from

val from: Double

Smallest value. Whether it is inclusive or not is determined by .fromInclusive

fromInclusive

val fromInclusive: Boolean = true

Whether the from value is included in the range

val to: Double

Largest value. Whether it is inclusive or not is determined by .toInclusive

toInclusive

val toInclusive: Boolean = true

Whether the to value is included in the range