ValueRange (Java Platform SE 8 ) (original) (raw)

java.lang.Object
- java.time.temporal.ValueRange
All Implemented Interfaces:
Serializable

public final class ValueRange
extends Object
implements Serializable
The range of valid values for a date-time field.
All 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.
Implementation Requirements:
This class is immutable and thread-safe.
Since:
1.8
See Also:
Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
int	checkValidIntValue(long value,TemporalField field)	Checks that the specified value is valid and fits in an int.
long	checkValidValue(long value,TemporalField field)	Checks that the specified value is valid.
boolean	equals(Object obj)	Checks if this range is equal to another range.
long	getLargestMinimum()	Gets the largest possible minimum value that the field can take.
long	getMaximum()	Gets the maximum value that the field can take.
long	getMinimum()	Gets the minimum value that the field can take.
long	getSmallestMaximum()	Gets the smallest possible maximum value that the field can take.
int	hashCode()	A hash code for this range.
boolean	isFixed()	Is the value range fixed and fully known.
boolean	isIntValue()	Checks if all values in the range fit in an int.
boolean	isValidIntValue(long value)	Checks if the value is within the valid range and that all values in the range fit in an int.
boolean	isValidValue(long value)	Checks if the value is within the valid range.
static ValueRange	of(long min, long max)	Obtains a fixed value range.
static ValueRange	of(long min, long maxSmallest, long maxLargest)	Obtains a variable value range.
static ValueRange	of(long minSmallest, long minLargest, long maxSmallest, long maxLargest)	Obtains a fully variable value range.
String	toString()	Outputs this range as a String.

   * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
   `[clone](../../../java/lang/Object.html#clone--), [finalize](../../../java/lang/Object.html#finalize--), [getClass](../../../java/lang/Object.html#getClass--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`

Method Detail

 * #### of  
 public static [ValueRange](../../../java/time/temporal/ValueRange.html "class in java.time.temporal") of(long min,  
                             long max)  
 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.  
 Parameters:  
 `min` \- the minimum value  
 `max` \- the maximum value  
 Returns:  
 the ValueRange for min, max, not null  
 Throws:  
 `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the minimum is greater than the maximum  
 * #### of  
 public static [ValueRange](../../../java/time/temporal/ValueRange.html "class in java.time.temporal") of(long min,  
                             long maxSmallest,  
                             long maxLargest)  
 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.  
 Parameters:  
 `min` \- the minimum value  
 `maxSmallest` \- the smallest maximum value  
 `maxLargest` \- the largest maximum value  
 Returns:  
 the ValueRange for min, smallest max, largest max, not null  
 Throws:  
 `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the minimum is greater than the smallest maximum, or the smallest maximum is greater than the largest maximum  
 * #### of  
 public static [ValueRange](../../../java/time/temporal/ValueRange.html "class in java.time.temporal") of(long minSmallest,  
                             long minLargest,  
                             long maxSmallest,  
                             long maxLargest)  
 Obtains a fully variable value range.  
  This factory obtains a range where both the minimum and maximum value may vary.  
 Parameters:  
 `minSmallest` \- the smallest minimum value  
 `minLargest` \- the largest minimum value  
 `maxSmallest` \- the smallest maximum value  
 `maxLargest` \- the largest maximum value  
 Returns:  
 the ValueRange for smallest min, largest min, smallest max, largest max, not null  
 Throws:  
 `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the smallest minimum is greater than the smallest maximum, or the smallest maximum is greater than the largest maximum or the largest minimum is greater than the largest maximum  
 * #### isFixed  
 public boolean isFixed()  
 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.  
 Returns:  
 true if the set of values is fixed  
 * #### getMinimum  
 public long getMinimum()  
 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.  
 Returns:  
 the minimum value for this field  
 * #### getLargestMinimum  
 public long getLargestMinimum()  
 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.  
 Returns:  
 the largest possible minimum value for this field  
 * #### getSmallestMaximum  
 public long getSmallestMaximum()  
 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.  
 Returns:  
 the smallest possible maximum value for this field  
 * #### getMaximum  
 public long getMaximum()  
 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.  
 Returns:  
 the maximum value for this field  
 * #### isIntValue  
 public boolean isIntValue()  
 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()](../../../java/time/temporal/ValueRange.html#getMinimum--) and [getMaximum()](../../../java/time/temporal/ValueRange.html#getMaximum--).  
 Returns:  
 true if a valid value always fits in an `int`  
 * #### isValidValue  
 public boolean isValidValue(long value)  
 Checks if the value is within the valid range.  
  This checks that the value is within the stored range of values.  
 Parameters:  
 `value` \- the value to check  
 Returns:  
 true if the value is valid  
 * #### isValidIntValue  
 public boolean isValidIntValue(long value)  
 Checks if the value is within the valid range and that all values in the range fit in an `int`.  
  This method combines [isIntValue()](../../../java/time/temporal/ValueRange.html#isIntValue--) and [isValidValue(long)](../../../java/time/temporal/ValueRange.html#isValidValue-long-).  
 Parameters:  
 `value` \- the value to check  
 Returns:  
 true if the value is valid and fits in an `int`  
 * #### checkValidValue  
 public long checkValidValue(long value,  
                             [TemporalField](../../../java/time/temporal/TemporalField.html "interface in java.time.temporal") field)  
 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.  
 Parameters:  
 `value` \- the value to check  
 `field` \- the field being checked, may be null  
 Returns:  
 the value that was passed in  
 See Also:  
 [isValidValue(long)](../../../java/time/temporal/ValueRange.html#isValidValue-long-)  
 * #### checkValidIntValue  
 public int checkValidIntValue(long value,  
                               [TemporalField](../../../java/time/temporal/TemporalField.html "interface in java.time.temporal") field)  
 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.  
 Parameters:  
 `value` \- the value to check  
 `field` \- the field being checked, may be null  
 Returns:  
 the value that was passed in  
 See Also:  
 [isValidIntValue(long)](../../../java/time/temporal/ValueRange.html#isValidIntValue-long-)  
 * #### equals  
 public boolean equals([Object](../../../java/lang/Object.html "class in java.lang") obj)  
 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.  
 Overrides:  
 `[equals](../../../java/lang/Object.html#equals-java.lang.Object-)` in class `[Object](../../../java/lang/Object.html "class in java.lang")`  
 Parameters:  
 `obj` \- the object to check, null returns false  
 Returns:  
 true if this is equal to the other range  
 See Also:  
 [Object.hashCode()](../../../java/lang/Object.html#hashCode--), [HashMap](../../../java/util/HashMap.html "class in java.util")  
 * #### hashCode  
 public int hashCode()  
 A hash code for this range.  
 Overrides:  
 `[hashCode](../../../java/lang/Object.html#hashCode--)` in class `[Object](../../../java/lang/Object.html "class in java.lang")`  
 Returns:  
 a suitable hash code  
 See Also:  
 [Object.equals(java.lang.Object)](../../../java/lang/Object.html#equals-java.lang.Object-), [System.identityHashCode(java.lang.Object)](../../../java/lang/System.html#identityHashCode-java.lang.Object-)  
 * #### toString  
 public [String](../../../java/lang/String.html "class in java.lang") toString()  
 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.  
 Overrides:  
 `[toString](../../../java/lang/Object.html#toString--)` in class `[Object](../../../java/lang/Object.html "class in java.lang")`  
 Returns:  
 a string representation of this range, not null

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

ValueRange (Java Platform SE 8 ) (original) (raw)

Method Summary

Method Detail