org.threeten.bp

DayOfWeek

final class DayOfWeek extends Enum[DayOfWeek] with TemporalAccessor with TemporalAdjuster

Linear Supertypes
TemporalAdjuster, TemporalAccessor, Enum[DayOfWeek], Serializable, Comparable[DayOfWeek], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DayOfWeek
  2. TemporalAdjuster
  3. TemporalAccessor
  4. Enum
  5. Serializable
  6. Comparable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DayOfWeek(name: String, ordinal: Int)

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def adjustInto(temporal: Temporal): Temporal

    Adjusts the specified temporal object to have this day-of-week.

    Adjusts the specified temporal object to have this day-of-week.

    This returns a temporal object of the same observable type as the input with the day-of-week changed to be the same as this.

    The adjustment is equivalent to using Temporal#with(TemporalField, long) passing ChronoField#DAY_OF_WEEK as the field. Note that this adjusts forwards or backwards within a Monday to Sunday week. See WeekFields#dayOfWeek for localized week start days. See TemporalAdjusters for other adjusters with more control, such as next(MONDAY).

    In most cases, it is clearer to reverse the calling pattern by using Temporal#with(TemporalAdjuster):

    // these two lines are equivalent, but the second approach is recommended
    temporal = thisDayOfWeek.adjustInto(temporal);
    temporal = temporal.with(thisDayOfWeek);
    

    For example, given a date that is a Wednesday, the following are output:

    dateOnWed.with(MONDAY);     // two days earlier
    dateOnWed.with(TUESDAY);    // one day earlier
    dateOnWed.with(WEDNESDAY);  // same date
    dateOnWed.with(THURSDAY);   // one day later
    dateOnWed.with(FRIDAY);     // two days later
    dateOnWed.with(SATURDAY);   // three days later
    dateOnWed.with(SUNDAY);     // four days later
    

    This instance is immutable and unaffected by this method call.

    temporal

    the target object to be adjusted, not null

    returns

    the adjusted object, not null

    Definition Classes
    DayOfWeekTemporalAdjuster
    Exceptions thrown
    ArithmeticException

    if numeric overflow occurs

    DateTimeException

    if unable to make the adjustment

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. final def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    Enum → AnyRef
    Annotations
    @throws( ... )
  9. final def compareTo(arg0: DayOfWeek): Int

    Definition Classes
    Enum → Comparable
  10. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  11. final def equals(arg0: Any): Boolean

    Definition Classes
    Enum → AnyRef → Any
  12. final def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    Enum → AnyRef
  13. def get(field: TemporalField): Int

    Gets the value of the specified field from this day-of-week as an int.

    Gets the value of the specified field from this day-of-week as an int.

    This queries this day-of-week for the value for the specified field. The returned value will always be within the valid range of values for the field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.

    If the field is ChronoField#DAY_OF_WEEK DAY_OF_WEEK then the value of the day-of-week, from 1 to 7, will be returned. All other ChronoField instances will throw a DateTimeException.

    If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

    field

    the field to get, not null

    returns

    the value for the field, within the valid range of values

    Definition Classes
    DayOfWeekTemporalAccessor
    Exceptions thrown
    ArithmeticException

    if numeric overflow occurs

    DateTimeException

    if the value is outside the range of valid values for the field

  14. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  15. final def getDeclaringClass(): Class[DayOfWeek]

    Definition Classes
    Enum
  16. def getDisplayName(style: TextStyle, locale: Locale): String

    Gets the textual representation, such as 'Mon' or 'Friday'.

    Gets the textual representation, such as 'Mon' or 'Friday'.

    This returns the textual name used to identify the day-of-week. The parameters control the length of the returned text and the locale.

    If no textual mapping is found then the #getValue() numeric value is returned.

    style

    the length of the text required, not null

    locale

    the locale to use, not null

    returns

    the text value of the day-of-week, not null

  17. def getLong(field: TemporalField): Long

    Gets the value of the specified field from this day-of-week as a long.

    Gets the value of the specified field from this day-of-week as a long.

    This queries this day-of-week for the value for the specified field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.

    If the field is ChronoField#DAY_OF_WEEK DAY_OF_WEEK then the value of the day-of-week, from 1 to 7, will be returned. All other ChronoField instances will throw a DateTimeException.

    If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

    field

    the field to get, not null

    returns

    the value for the field

    Definition Classes
    DayOfWeekTemporalAccessor
    Exceptions thrown
    ArithmeticException

    if numeric overflow occurs

    DateTimeException

    if a value for the field cannot be obtained

  18. def getValue: Int

    Gets the day-of-week int value.

    Gets the day-of-week int value.

    The values are numbered following the ISO-8601 standard, from 1 (Monday) to 7 (Sunday). See WeekFields#dayOfWeek for localized week-numbering.

    returns

    the day-of-week, from 1 (Monday) to 7 (Sunday)

  19. final def hashCode(): Int

    Definition Classes
    Enum → AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. def isSupported(field: TemporalField): Boolean

    Checks if the specified field is supported.

    Checks if the specified field is supported.

    This checks if this day-of-week can be queried for the specified field. If false, then calling the #range(TemporalField) range and #get(TemporalField) get methods will throw an exception.

    If the field is ChronoField#DAY_OF_WEEK DAY_OF_WEEK then this method returns true. All other ChronoField instances will return false.

    If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.isSupportedBy(TemporalAccessor) passing this as the argument. Whether the field is supported is determined by the field.

    field

    the field to check, null returns false

    returns

    true if the field is supported on this day-of-week, false if not

    Definition Classes
    DayOfWeekTemporalAccessor
  22. def minus(days: Long): DayOfWeek

    Returns the day-of-week that is the specified number of days before this one.

    Returns the day-of-week that is the specified number of days before this one.

    The calculation rolls around the start of the year from Monday to Sunday. The specified period may be negative.

    This instance is immutable and unaffected by this method call.

    days

    the days to subtract, positive or negative

    returns

    the resulting day-of-week, not null

  23. final def name(): String

    Definition Classes
    Enum
  24. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  27. final def ordinal(): Int

    Definition Classes
    Enum
  28. def plus(days: Long): DayOfWeek

    Returns the day-of-week that is the specified number of days after this one.

    Returns the day-of-week that is the specified number of days after this one.

    The calculation rolls around the end of the week from Sunday to Monday. The specified period may be negative.

    This instance is immutable and unaffected by this method call.

    days

    the days to add, positive or negative

    returns

    the resulting day-of-week, not null

  29. def query[R](query: TemporalQuery[R]): R

    Queries this day-of-week using the specified query.

    Queries this day-of-week using the specified query.

    This queries this day-of-week using the specified query strategy object. The TemporalQuery object defines the logic to be used to obtain the result. Read the documentation of the query to understand what the result of this method will be.

    The result of this method is obtained by invoking the TemporalQuery#queryFrom(TemporalAccessor) method on the specified query passing this as the argument.

    R

    the type of the result

    query

    the query to invoke, not null

    returns

    the query result, null may be returned (defined by the query)

    Definition Classes
    DayOfWeekTemporalAccessor
    Exceptions thrown
    ArithmeticException

    if numeric overflow occurs (defined by the query)

    DateTimeException

    if unable to query (defined by the query)

  30. def range(field: TemporalField): ValueRange

    Gets the range of valid values for the specified field.

    Gets the range of valid values for the specified field.

    The range object expresses the minimum and maximum valid values for a field. This day-of-week is used to enhance the accuracy of the returned range. If it is not possible to return the range, because the field is not supported or for some other reason, an exception is thrown.

    If the field is ChronoField#DAY_OF_WEEK DAY_OF_WEEK then the range of the day-of-week, from 1 to 7, will be returned. All other ChronoField instances will throw a DateTimeException.

    If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.rangeRefinedBy(TemporalAccessor) passing this as the argument. Whether the range can be obtained is determined by the field.

    field

    the field to query the range for, not null

    returns

    the range of valid values for the field, not null

    Definition Classes
    DayOfWeekTemporalAccessor
    Exceptions thrown
    DateTimeException

    if the range for the field cannot be obtained

  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  32. def toString(): String

    Definition Classes
    Enum → AnyRef → Any
  33. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from TemporalAdjuster

Inherited from TemporalAccessor

Inherited from Enum[DayOfWeek]

Inherited from Serializable

Inherited from Comparable[DayOfWeek]

Inherited from AnyRef

Inherited from Any

Ungrouped