# Calendar.WeekData

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

# WeekData

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/icu/util/Calendar.WeekData "View this page in Java")  

```
class WeekData
```

|---|--------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                           ||
| ↳ | [android.icu.util.Calendar.WeekData](https://developer.android.com/reference/kotlin/android/icu/util/Calendar.WeekData#) |

Simple, immutable struct-like class for access to the CLDR week data.

## Summary

|                                                                                                                                                                                                                                                                                                                                                                                    Public constructors                                                                                                                                                                                                                                                                                                                                                                                     ||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [WeekData](https://developer.android.com/reference/kotlin/android/icu/util/Calendar.WeekData#WeekData(kotlin.Int,%20kotlin.Int,%20kotlin.Int,%20kotlin.Int,%20kotlin.Int,%20kotlin.Int))`(`fdow:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `mdifw:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `weekendOnset:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `weekendOnsetMillis:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `weekendCease:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `weekendCeaseMillis:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Constructor |

|                                                                                                                                                                      Public methods                                                                                                                                                                      ||
|------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [equals](https://developer.android.com/reference/kotlin/android/icu/util/Calendar.WeekData#equals(kotlin.Any))`(`other:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?`)` Indicates whether some other object is "equal to" this one. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)         | [hashCode](https://developer.android.com/reference/kotlin/android/icu/util/Calendar.WeekData#hashCode())`()` Returns a hash code value for the object.                                                                                                               |
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)   | [toString](https://developer.android.com/reference/kotlin/android/icu/util/Calendar.WeekData#toString())`()` Returns a string representation of the object.                                                                                                          |

|                                                                                                                                                                                                                            Properties                                                                                                                                                                                                                             ||
|----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [firstDayOfWeek](https://developer.android.com/reference/kotlin/android/icu/util/Calendar.WeekData#firstDayOfWeek:kotlin.Int) the first day of the week, where 1 =[SUNDAY](https://developer.android.com/reference/kotlin/android/icu/util/Calendar#SUNDAY:kotlin.Int)and 7 =[SATURDAY](https://developer.android.com/reference/kotlin/android/icu/util/Calendar#SATURDAY:kotlin.Int) |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [minimalDaysInFirstWeek](https://developer.android.com/reference/kotlin/android/icu/util/Calendar.WeekData#minimalDaysInFirstWeek:kotlin.Int) the minimal number of days in the first week                                                                                                                                                                                            |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [weekendCease](https://developer.android.com/reference/kotlin/android/icu/util/Calendar.WeekData#weekendCease:kotlin.Int) the cease day, where 1 =[SUNDAY](https://developer.android.com/reference/kotlin/android/icu/util/Calendar#SUNDAY:kotlin.Int)and 7 =[SATURDAY](https://developer.android.com/reference/kotlin/android/icu/util/Calendar#SATURDAY:kotlin.Int)                 |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [weekendCeaseMillis](https://developer.android.com/reference/kotlin/android/icu/util/Calendar.WeekData#weekendCeaseMillis:kotlin.Int) the cease time in millis during the cease day.                                                                                                                                                                                                  |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [weekendOnset](https://developer.android.com/reference/kotlin/android/icu/util/Calendar.WeekData#weekendOnset:kotlin.Int) the onset day, where 1 =[SUNDAY](https://developer.android.com/reference/kotlin/android/icu/util/Calendar#SUNDAY:kotlin.Int)and 7 =[SATURDAY](https://developer.android.com/reference/kotlin/android/icu/util/Calendar#SATURDAY:kotlin.Int)                 |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [weekendOnsetMillis](https://developer.android.com/reference/kotlin/android/icu/util/Calendar.WeekData#weekendOnsetMillis:kotlin.Int) the onset time in millis during the onset day                                                                                                                                                                                                   |

## Public constructors

### WeekData

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

```
WeekData(
    fdow: Int, 
    mdifw: Int, 
    weekendOnset: Int, 
    weekendOnsetMillis: Int, 
    weekendCease: Int, 
    weekendCeaseMillis: Int)
```

Constructor

|                                                                                                                                                                        Parameters                                                                                                                                                                        ||
|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `fdow`               | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):the first day of the week, where 1 =[SUNDAY](https://developer.android.com/reference/kotlin/android/icu/util/Calendar#SUNDAY:kotlin.Int)and 7 =[SATURDAY](https://developer.android.com/reference/kotlin/android/icu/util/Calendar#SATURDAY:kotlin.Int) |
| `mdifw`              | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):the minimal number of days in the first week                                                                                                                                                                                                            |
| `weekendOnset`       | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):the onset day, where 1 = Sunday and 7 = Saturday                                                                                                                                                                                                        |
| `weekendOnsetMillis` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):the onset time in millis during the onset day                                                                                                                                                                                                           |
| `weekendCease`       | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):the cease day, where 1 = Sunday and 7 = Saturday                                                                                                                                                                                                        |
| `weekendCeaseMillis` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):the cease time in millis during the cease day.                                                                                                                                                                                                          |

## Public methods

### equals

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

```
fun equals(other: Any?): Boolean
```

Indicates whether some other object is "equal to" this one.

The`equals`method implements an equivalence relation on non-null object references:

- It is*reflexive* : for any non-null reference value`x`,`x.equals(x)`should return`true`.
- It is*symmetric* : for any non-null reference values`x`and`y`,`x.equals(y)`should return`true`if and only if`y.equals(x)`returns`true`.
- It is*transitive* : for any non-null reference values`x`,`y`, and`z`, if`x.equals(y)`returns`true`and`y.equals(z)`returns`true`, then`x.equals(z)`should return`true`.
- It is*consistent* : for any non-null reference values`x`and`y`, multiple invocations of`x.equals(y)`consistently return`true`or consistently return`false`, provided no information used in`equals`comparisons on the objects is modified.
- For any non-null reference value`x`,`x.equals(null)`should return`false`.

An equivalence relation partitions the elements it operates on into*equivalence classes*; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

|                     Parameters                     ||
|-------|---------------------------------------------|
| `obj` | the reference object with which to compare. |

|                                                                           Return                                                                           ||
|------------------------------------------------------------------------------------|------------------------------------------------------------------------|
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true`if this object is the same as the obj argument;`false`otherwise. |

### hashCode

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

```
fun hashCode(): Int
```

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by[java.util.HashMap](https://developer.android.com/reference/kotlin/java/util/HashMap.html#).

The general contract of`hashCode`is:

- Whenever it is invoked on the same object more than once during an execution of a Java application, the`hashCode`method must consistently return the same integer, provided no information used in`equals`comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the[equals](https://developer.android.com/reference/kotlin/java/lang/Object.html#equals(kotlin.Any))method, then calling the`hashCode`method on each of the two objects must produce the same integer result.
- It is*not* required that if two objects are unequal according to the[equals](https://developer.android.com/reference/kotlin/java/lang/Object.html#equals(kotlin.Any))method, then calling the`hashCode`method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

|                                                     Return                                                     ||
|----------------------------------------------------------------------------|------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a hash code value for this object. |

### toString

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

```
fun toString(): String
```

Returns a string representation of the object.

|                                                          Return                                                          ||
|----------------------------------------------------------------------------------|----------------------------------------|
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | a string representation of the object. |

## Properties

### firstDayOfWeek

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

```
val firstDayOfWeek: Int
```

the first day of the week, where 1 =[SUNDAY](https://developer.android.com/reference/kotlin/android/icu/util/Calendar#SUNDAY:kotlin.Int)and 7 =[SATURDAY](https://developer.android.com/reference/kotlin/android/icu/util/Calendar#SATURDAY:kotlin.Int)  

### minimalDaysInFirstWeek

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

```
val minimalDaysInFirstWeek: Int
```

the minimal number of days in the first week  

### weekendCease

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

```
val weekendCease: Int
```

the cease day, where 1 =[SUNDAY](https://developer.android.com/reference/kotlin/android/icu/util/Calendar#SUNDAY:kotlin.Int)and 7 =[SATURDAY](https://developer.android.com/reference/kotlin/android/icu/util/Calendar#SATURDAY:kotlin.Int)  

### weekendCeaseMillis

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

```
val weekendCeaseMillis: Int
```

the cease time in millis during the cease day. Exclusive, so the max is 24:00:00.000. Note that this will format as 00:00 the next day.  

### weekendOnset

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

```
val weekendOnset: Int
```

the onset day, where 1 =[SUNDAY](https://developer.android.com/reference/kotlin/android/icu/util/Calendar#SUNDAY:kotlin.Int)and 7 =[SATURDAY](https://developer.android.com/reference/kotlin/android/icu/util/Calendar#SATURDAY:kotlin.Int)  

### weekendOnsetMillis

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

```
val weekendOnsetMillis: Int
```

the onset time in millis during the onset day