Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/icu/text/DateIntervalInfo#nestedclasses) \| [Ctors](https://developer.android.com/reference/android/icu/text/DateIntervalInfo#pubctors) \| [Methods](https://developer.android.com/reference/android/icu/text/DateIntervalInfo#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/icu/text/DateIntervalInfo#inhmethods)

# DateIntervalInfo

*** ** * ** ***


`
public


class
DateIntervalInfo
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/java/lang/Cloneable,

https://developer.android.com/reference/android/icu/util/Freezable<https://developer.android.com/reference/android/icu/text/DateIntervalInfo>,

https://developer.android.com/reference/java/io/Serializable


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.icu.text.DateIntervalInfo |

<br />

*** ** * ** ***

DateIntervalInfo is a public class for encapsulating localizable
date time interval patterns. It is used by DateIntervalFormat.


For most users, ordinary use of DateIntervalFormat does not need to create
DateIntervalInfo object directly.
DateIntervalFormat will take care of it when creating a date interval
formatter when user pass in skeleton and locale.


For power users, who want to create their own date interval patterns,
or want to re-set date interval patterns, they could do so by
directly creating DateIntervalInfo and manipulating it.


Logically, the interval patterns are mappings
from (skeleton, the_largest_different_calendar_field)
to (date_interval_pattern).


A skeleton

1. only keeps the field pattern letter and ignores all other parts in a pattern, such as space, punctuations, and string literals.
2. hides the order of fields.
3. might hide a field's pattern letter length. For those non-digit calendar fields, the pattern letter length is important, such as MMM, MMMM, and MMMMM; EEE and EEEE, and the field's pattern letter length is honored. For the digit calendar fields, such as M or MM, d or dd, yy or yyyy, the field pattern length is ignored and the best match, which is defined in date time patterns, will be returned without honor the field pattern letter length in skeleton.


The calendar fields we support for interval formatting are:
year, month, date, day-of-week, am-pm, hour, hour-of-day, minute, and
second (though we do not currently have specific intervalFormat data for
skeletons with seconds).
Those calendar fields can be defined in the following order:
year \> month \> date \> am-pm \> hour \> minute \> second

The largest different calendar fields between 2 calendars is the
first different calendar field in above order.

For example: the largest different calendar fields between "Jan 10, 2007"
and "Feb 20, 2008" is year.


There is a set of pre-defined static skeleton strings.
There are pre-defined interval patterns for those pre-defined skeletons
in locales' resource files.
For example, for a skeleton YEAR_ABBR_MONTH_DAY, which is "yMMMd",
in en_US, if the largest different calendar field between date1 and date2
is "year", the date interval pattern is "MMM d, yyyy - MMM d, yyyy",
such as "Jan 10, 2007 - Jan 10, 2008".
If the largest different calendar field between date1 and date2 is "month",
the date interval pattern is "MMM d - MMM d, yyyy",
such as "Jan 10 - Feb 10, 2007".
If the largest different calendar field between date1 and date2 is "day",
the date interval pattern is ""MMM d-d, yyyy", such as "Jan 10-20, 2007".

For date skeleton, the interval patterns when year, or month, or date is
different are defined in resource files.
For time skeleton, the interval patterns when am/pm, or hour, or minute is
different are defined in resource files.


There are 2 dates in interval pattern. For most locales, the first date
in an interval pattern is the earlier date. There might be a locale in which
the first date in an interval pattern is the later date.
We use fallback format for the default order for the locale.
For example, if the fallback format is "{0} - {1}", it means
the first date in the interval pattern for this locale is earlier date.
If the fallback format is "{1} - {0}", it means the first date is the
later date.
For a particular interval pattern, the default order can be overridden
by prefixing "latestFirst:" or "earliestFirst:" to the interval pattern.
For example, if the fallback format is "{0}-{1}",
but for skeleton "yMMMd", the interval pattern when day is different is
"latestFirst:d-d MMM yy", it means by default, the first date in interval
pattern is the earlier date. But for skeleton "yMMMd", when day is different,
the first date in "d-d MMM yy" is the later date.


The recommended way to create a DateIntervalFormat object is to pass in
the locale.
By using a Locale parameter, the DateIntervalFormat object is
initialized with the pre-defined interval patterns for a given or
default locale.


Users can also create DateIntervalFormat object
by supplying their own interval patterns.
It provides flexibility for power usage.


After a DateIntervalInfo object is created, clients may modify
the interval patterns using setIntervalPattern function as so desired.
Currently, users can only set interval patterns when the following
calendar fields are different: ERA, YEAR, MONTH, DATE, DAY_OF_MONTH,
DAY_OF_WEEK, AM_PM, HOUR, HOUR_OF_DAY, MINUTE, SECOND, and MILLISECOND.
Interval patterns when other calendar fields are different is not supported.


DateIntervalInfo objects are cloneable.
When clients obtain a DateIntervalInfo object,
they can feel free to modify it as necessary.


DateIntervalInfo are not expected to be subclassed.
Data for a calendar is loaded out of resource bundles.
Through ICU 4.4, date interval patterns are only supported in the Gregorian
calendar; non-Gregorian calendars are supported from ICU 4.4.1.

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/icu/text/DateIntervalInfo.PatternInfo` PatternInfo class saves the first and second part of interval pattern, and whether the interval pattern is earlier date first. |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/icu/text/DateIntervalInfo#DateIntervalInfo(android.icu.util.ULocale)(https://developer.android.com/reference/android/icu/util/ULocale locale) ` Construct DateIntervalInfo for the given locale, |
| ` https://developer.android.com/reference/android/icu/text/DateIntervalInfo#DateIntervalInfo(java.util.Locale)(https://developer.android.com/reference/java/util/Locale locale) ` Construct DateIntervalInfo for the given `https://developer.android.com/reference/java/util/Locale`. |

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/android/icu/text/DateIntervalInfo#clone()() ` Clone this object. |
| ` https://developer.android.com/reference/android/icu/text/DateIntervalInfo` | ` https://developer.android.com/reference/android/icu/text/DateIntervalInfo#cloneAsThawed()() ` Provides for the clone operation. |
| ` boolean` | ` https://developer.android.com/reference/android/icu/text/DateIntervalInfo#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object a) ` Override equals |
| ` https://developer.android.com/reference/android/icu/text/DateIntervalInfo` | ` https://developer.android.com/reference/android/icu/text/DateIntervalInfo#freeze()() ` Freezes the object. |
| ` boolean` | ` https://developer.android.com/reference/android/icu/text/DateIntervalInfo#getDefaultOrder()() ` Get default order -- whether the first date in pattern is later date or not. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/icu/text/DateIntervalInfo#getFallbackIntervalPattern()() ` Get the fallback interval pattern. |
| ` https://developer.android.com/reference/android/icu/text/DateIntervalInfo.PatternInfo` | ` https://developer.android.com/reference/android/icu/text/DateIntervalInfo#getIntervalPattern(java.lang.String,%20int)(https://developer.android.com/reference/java/lang/String skeleton, int field) ` Get the interval pattern given the largest different calendar field. |
| ` int` | ` https://developer.android.com/reference/android/icu/text/DateIntervalInfo#hashCode()() ` Override hashcode |
| ` boolean` | ` https://developer.android.com/reference/android/icu/text/DateIntervalInfo#isFrozen()() ` Determines whether the object has been frozen or not. |
| ` void` | ` https://developer.android.com/reference/android/icu/text/DateIntervalInfo#setFallbackIntervalPattern(java.lang.String)(https://developer.android.com/reference/java/lang/String fallbackPattern) ` Re-set the fallback interval pattern. |
| ` void` | ` https://developer.android.com/reference/android/icu/text/DateIntervalInfo#setIntervalPattern(java.lang.String,%20int,%20java.lang.String)(https://developer.android.com/reference/java/lang/String skeleton, int lrgDiffCalUnit, https://developer.android.com/reference/java/lang/String intervalPattern) ` Provides a way for client to build interval patterns. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||
| From interface ` https://developer.android.com/reference/android/icu/util/Freezable ` |---|---| | ` abstract https://developer.android.com/reference/android/icu/text/DateIntervalInfo` | ` https://developer.android.com/reference/android/icu/util/Freezable#cloneAsThawed()() ` Provides for the clone operation. | | ` abstract https://developer.android.com/reference/android/icu/text/DateIntervalInfo` | ` https://developer.android.com/reference/android/icu/util/Freezable#freeze()() ` Freezes the object. | | ` abstract boolean` | ` https://developer.android.com/reference/android/icu/util/Freezable#isFrozen()() ` Determines whether the object has been frozen or not. | ||

## Public constructors

### DateIntervalInfo

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public DateIntervalInfo (ULocale locale)
```

Construct DateIntervalInfo for the given locale,

<br />

| Parameters ||
|---|---|
| `locale` | `ULocale`: the interval patterns are loaded from the appropriate calendar data (specified calendar or default calendar) in this locale. <br /> |

### DateIntervalInfo

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public DateIntervalInfo (Locale locale)
```

Construct DateIntervalInfo for the given `https://developer.android.com/reference/java/util/Locale`.

<br />

| Parameters ||
|---|---|
| `locale` | `Locale`: the interval patterns are loaded from the appropriate calendar data (specified calendar or default calendar) in this locale. <br /> |

## Public methods

### clone

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Object clone ()
```

Clone this object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/Object` | a copy of the object <br /> |

### cloneAsThawed

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public DateIntervalInfo cloneAsThawed ()
```

Provides for the clone operation. Any clone is initially unfrozen.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/icu/text/DateIntervalInfo` | <br /> |

### equals

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean equals (Object a)
```

Override equals

<br />

| Parameters ||
|---|---|
| `a` | `Object`: the reference object with which to compare. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### freeze

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public DateIntervalInfo freeze ()
```

Freezes the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/icu/text/DateIntervalInfo` | the object itself. <br /> |

### getDefaultOrder

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean getDefaultOrder ()
```

Get default order -- whether the first date in pattern is later date
or not.

return default date ordering in interval pattern. true if the first date
in pattern is later date, false otherwise.

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### getFallbackIntervalPattern

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getFallbackIntervalPattern ()
```

Get the fallback interval pattern.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | fallback interval pattern <br /> |

### getIntervalPattern

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public DateIntervalInfo.PatternInfo getIntervalPattern (String skeleton, 
                int field)
```

Get the interval pattern given the largest different calendar field.

<br />

| Parameters ||
|---|---|
| `skeleton` | `String`: the skeleton <br /> |
| `field` | `int`: the largest different calendar field <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/icu/text/DateIntervalInfo.PatternInfo` | interval pattern return null if interval pattern is not found. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if getting interval pattern on a calendar field that is smaller than the MINIMUM_SUPPORTED_CALENDAR_FIELD |

### hashCode

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int hashCode ()
```

Override hashcode

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### isFrozen

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isFrozen ()
```

Determines whether the object has been frozen or not.

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### setFallbackIntervalPattern

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void setFallbackIntervalPattern (String fallbackPattern)
```

Re-set the fallback interval pattern.

In construction, default fallback pattern is set as "{0} - {1}".
And constructor taking locale as parameter will set the
fallback pattern as what defined in the locale resource file.

This method provides a way for user to replace the fallback pattern.

<br />

| Parameters ||
|---|---|
| `fallbackPattern` | `String`: fall-back interval pattern. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if there is no pattern {0} or pattern {1} in fallbakckPattern |
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException` | if the object is frozen |

### setIntervalPattern

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void setIntervalPattern (String skeleton, 
                int lrgDiffCalUnit, 
                String intervalPattern)
```

Provides a way for client to build interval patterns.
User could construct DateIntervalInfo by providing
a list of skeletons and their patterns.


For example:

```
DateIntervalInfo dIntervalInfo = new DateIntervalInfo();
dIntervalInfo.setIntervalPattern("yMd", Calendar.YEAR, "'from' yyyy-M-d 'to' yyyy-M-d");
dIntervalInfo.setIntervalPattern("yMMMd", Calendar.MONTH, "'from' yyyy MMM d 'to' MMM d");
dIntervalInfo.setIntervalPattern("yMMMd", Calendar.DAY, "yyyy MMM d-d");
dIntervalInfo.setFallbackIntervalPattern("{0} ~ {1}");
```
Restriction: Currently, users can only set interval patterns when the following calendar fields are different: ERA, YEAR, MONTH, DATE, DAY_OF_MONTH, DAY_OF_WEEK, AM_PM, HOUR, HOUR_OF_DAY, MINUTE, SECOND, and MILLISECOND. Interval patterns when other calendar fields are different are not supported.

<br />

<br />

| Parameters ||
|---|---|
| `skeleton` | `String`: the skeleton on which interval pattern based <br /> |
| `lrgDiffCalUnit` | `int`: the largest different calendar unit. <br /> |
| `intervalPattern` | `String`: the interval pattern on the largest different calendar unit. For example, if lrgDiffCalUnit is "year", the interval pattern for en_US when year is different could be "'from' yyyy 'to' yyyy". <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if setting interval pattern on a calendar field that is smaller than the MINIMUM_SUPPORTED_CALENDAR_FIELD |
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException` | if the object is frozen |