|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.time.calendar.DateTimeRuleRange
public final class DateTimeRuleRange
The range of valid values for a date-time field.
All DateTimeField
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.
Instances of this class are not tied to a specific rule
This class is immutable and thread-safe.
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
|
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()
|
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 DateTimeRuleRange |
of(long min,
long max)
Obtains a fixed value range. |
static DateTimeRuleRange |
of(long min,
long maxSmallest,
long maxLargest)
Obtains a variable value range. |
static DateTimeRuleRange |
of(long minSmallest,
long minLargest,
long maxSmallest,
long maxLargest)
Obtains a fully variable value range. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public static DateTimeRuleRange of(long min, long max)
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.
min
- the minimum valuemax
- the maximum valuepublic static DateTimeRuleRange of(long min, long maxSmallest, long maxLargest)
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.
min
- the minimum valuemaxSmallest
- the smallest maximum valuemaxLargest
- the largest maximum valuepublic static DateTimeRuleRange of(long minSmallest, long minLargest, long maxSmallest, long maxLargest)
This factory obtains a range where both the minimum and maximum value may vary.
minSmallest
- the smallest minimum valueminLargest
- the largest minimum valuemaxSmallest
- the smallest maximum valuemaxLargest
- the largest maximum valuepublic boolean isFixed()
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.
public long getMinimum()
For example, the ISO day-of-month always starts at 1. The minimum is therefore 1.
public long getLargestMinimum()
For example, the ISO day-of-month always starts at 1. The largest minimum is therefore 1.
public long getSmallestMaximum()
For example, the ISO day-of-month runs to between 28 and 31 days. The smallest maximum is therefore 28.
public long getMaximum()
For example, the ISO day-of-month runs to between 28 and 31 days. The maximum is therefore 31.
public boolean isIntValue()
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()
and getMaximum()
.
int
public boolean isValidValue(long value)
This checks that the value is within the stored range of values.
value
- the value to check
public boolean isValidIntValue(long value)
int
.
This method combines isIntValue()
and isValidValue(long)
.
value
- the value to check
int
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |