ValueRange  |  API reference  |  Android Developers (original) (raw)

class ValueRange : Serializable

The range of valid values for a date-time field.

All [TemporalField](/reference/kotlin/java/time/temporal/TemporalField) instances have a valid range of values. For example, the ISO day-of-month runs from 1 to somewhere between 28 and 31. This class captures that valid range.

It is important to be aware of the limitations of this class. Only the minimum and maximum values are provided. It is possible for there to be invalid values within the outer range. For example, a weird field may have valid values of 1, 2, 4, 6, 7, thus have a range of '1 - 7', despite that fact that values 3 and 5 are invalid.

Instances of this class are not tied to a specific field.

Summary

Public methods

checkValidIntValue

fun checkValidIntValue(
    value: Long,
    field: TemporalField!
): Int

Checks that the specified value is valid and fits in an int.

This validates that the value is within the valid range of values and that all valid values are within the bounds of an int. The field is only used to improve the error message.

checkValidValue

fun checkValidValue(
    value: Long,
    field: TemporalField!
): Long

Checks that the specified value is valid.

This validates that the value is within the valid range of values. The field is only used to improve the error message.

equals

fun equals(other: Any?): Boolean

Checks if this range is equal to another range.

The comparison is based on the four values, minimum, largest minimum, smallest maximum and maximum. Only objects of type ValueRange are compared, other types return false.

getLargestMinimum

fun getLargestMinimum(): Long

Gets the largest possible minimum value that the field can take.

For example, the ISO day-of-month always starts at 1. The largest minimum is therefore 1.

getMaximum

fun getMaximum(): Long

Gets the maximum value that the field can take.

For example, the ISO day-of-month runs to between 28 and 31 days. The maximum is therefore 31.

getMinimum

fun getMinimum(): Long

Gets the minimum value that the field can take.

For example, the ISO day-of-month always starts at 1. The minimum is therefore 1.

getSmallestMaximum

fun getSmallestMaximum(): Long

Gets the smallest possible maximum value that the field can take.

For example, the ISO day-of-month runs to between 28 and 31 days. The smallest maximum is therefore 28.

hashCode

fun hashCode(): Int

A hash code for this range.

isFixed

fun isFixed(): Boolean

Is the value range fixed and fully known.

For example, the ISO day-of-month runs from 1 to between 28 and 31. Since there is uncertainty about the maximum value, the range is not fixed. However, for the month of January, the range is always 1 to 31, thus it is fixed.

isIntValue

fun isIntValue(): Boolean

Checks if all values in the range fit in an int.

This checks that all valid values are within the bounds of an int.

For example, the ISO month-of-year has values from 1 to 12, which fits in an int. By comparison, ISO nano-of-day runs from 1 to 86,400,000,000,000 which does not fit in an int.

This implementation uses [getMinimum()](#getMinimum%28%29) and [getMaximum()](#getMaximum%28%29).

isValidIntValue

fun isValidIntValue(value: Long): Boolean

Checks if the value is within the valid range and that all values in the range fit in an int.

This method combines [isIntValue()](#isIntValue%28%29) and [isValidValue(long)](#isValidValue%28kotlin.Long%29).

isValidValue

fun isValidValue(value: Long): Boolean

Checks if the value is within the valid range.

This checks that the value is within the stored range of values.

of

static fun of(
    min: Long,
    max: Long
): ValueRange!

Obtains a fixed value range.

This factory obtains a range where the minimum and maximum values are fixed. For example, the ISO month-of-year always runs from 1 to 12.

of

static fun of(
    min: Long,
    maxSmallest: Long,
    maxLargest: Long
): ValueRange!

Obtains a variable value range.

This factory obtains a range where the minimum value is fixed and the maximum value may vary. For example, the ISO day-of-month always starts at 1, but ends between 28 and 31.

of

static fun of(
    minSmallest: Long,
    minLargest: Long,
    maxSmallest: Long,
    maxLargest: Long
): ValueRange!

Obtains a fully variable value range.

This factory obtains a range where both the minimum and maximum value may vary.

toString

fun toString(): String

Outputs this range as a String.

The format will be '{min}/{largestMin} - {smallestMax}/{max}', where the largestMin or smallestMax sections may be omitted, together with associated slash, if they are the same as the min or max.