Added in API level 24

WeekData


class WeekData
kotlin.Any
   ↳ android.icu.util.Calendar.WeekData

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

Summary

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

Constructor

Public methods
Boolean
equals(other: Any?)

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

Int

Returns a hash code value for the object.

String

Returns a string representation of the object.

Properties
Int

the first day of the week, where 1 = SUNDAY and 7 = SATURDAY

Int

the minimal number of days in the first week

Int

the cease day, where 1 = SUNDAY and 7 = SATURDAY

Int

the cease time in millis during the cease day.

Int

the onset day, where 1 = SUNDAY and 7 = SATURDAY

Int

the onset time in millis during the onset day

Public constructors

WeekData

Added in API level 24
WeekData(
    fdow: Int,
    mdifw: Int,
    weekendOnset: Int,
    weekendOnsetMillis: Int,
    weekendCease: Int,
    weekendCeaseMillis: Int)

Constructor

Parameters
fdow Int: the first day of the week, where 1 = SUNDAY and 7 = SATURDAY
mdifw Int: the minimal number of days in the first week
weekendOnset Int: the onset day, where 1 = Sunday and 7 = Saturday
weekendOnsetMillis Int: the onset time in millis during the onset day
weekendCease Int: the cease day, where 1 = Sunday and 7 = Saturday
weekendCeaseMillis Int: the cease time in millis during the cease day.

Public methods

equals

Added in API level 24
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 true if this object is the same as the obj argument; false otherwise.

hashCode

Added in API level 24
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.

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 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 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 a hash code value for this object.

toString

Added in API level 24
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

Properties

firstDayOfWeek

Added in API level 24
val firstDayOfWeek: Int

the first day of the week, where 1 = SUNDAY and 7 = SATURDAY

minimalDaysInFirstWeek

Added in API level 24
val minimalDaysInFirstWeek: Int

the minimal number of days in the first week

weekendCease

Added in API level 24
val weekendCease: Int

the cease day, where 1 = SUNDAY and 7 = SATURDAY

weekendCeaseMillis

Added in API level 24
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
val weekendOnset: Int

the onset day, where 1 = SUNDAY and 7 = SATURDAY

weekendOnsetMillis

Added in API level 24
val weekendOnsetMillis: Int

the onset time in millis during the onset day