Added in API level 26

Summary: Enums | Methods | Inherited Methods

DayOfWeek

public final enum DayOfWeek
extends Enum<DayOfWeek> implements TemporalAccessor, TemporalAdjuster

java.lang.Object
↳	java.lang.Enum<java.time.DayOfWeek>
	↳	java.time.DayOfWeek

A day-of-week, such as 'Tuesday'.

DayOfWeek is an enum representing the 7 days of the week - Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.

In addition to the textual enum name, each day-of-week has an int value. The int value follows the ISO-8601 standard, from 1 (Monday) to 7 (Sunday). It is recommended that applications use the enum rather than the int value to ensure code clarity.

This enum provides access to the localized textual form of the day-of-week. Some locales also assign different numeric values to the days, declaring Sunday to have the value 1, however this class provides no support for this. See WeekFields for localized week-numbering.

Do not use ordinal() to obtain the numeric representation of DayOfWeek. Use getValue() instead.

This enum represents a common concept that is found in many calendar systems. As such, this enum may be used by any calendar system that has the day-of-week concept defined exactly equivalent to the ISO calendar system.

Summary

Enum values
`DayOfWeek`	`FRIDAY` The singleton instance for the day-of-week of Friday.
`DayOfWeek`	`MONDAY` The singleton instance for the day-of-week of Monday.
`DayOfWeek`	`SATURDAY` The singleton instance for the day-of-week of Saturday.
`DayOfWeek`	`SUNDAY` The singleton instance for the day-of-week of Sunday.
`DayOfWeek`	`THURSDAY` The singleton instance for the day-of-week of Thursday.
`DayOfWeek`	`TUESDAY` The singleton instance for the day-of-week of Tuesday.
`DayOfWeek`	`WEDNESDAY` The singleton instance for the day-of-week of Wednesday.

Public methods
`Temporal`	`adjustInto(Temporal temporal)` Adjusts the specified temporal object to have this day-of-week.
`static DayOfWeek`	`from(TemporalAccessor temporal)` Obtains an instance of `DayOfWeek` from a temporal object.
`int`	`get(TemporalField field)` Gets the value of the specified field from this day-of-week as an `int`.
`String`	`getDisplayName(TextStyle style, Locale locale)` Gets the textual representation, such as 'Mon' or 'Friday'.
`long`	`getLong(TemporalField field)` Gets the value of the specified field from this day-of-week as a `long`.
`int`	`getValue()` Gets the day-of-week `int` value.
`boolean`	`isSupported(TemporalField field)` Checks if the specified field is supported.
`DayOfWeek`	`minus(long days)` Returns the day-of-week that is the specified number of days before this one.
`static DayOfWeek`	`of(int dayOfWeek)` Obtains an instance of `DayOfWeek` from an `int` value.
`DayOfWeek`	`plus(long days)` Returns the day-of-week that is the specified number of days after this one.
`<R> R`	`query(TemporalQuery<R> query)` Queries this day-of-week using the specified query.
`ValueRange`	`range(TemporalField field)` Gets the range of valid values for the specified field.
`static DayOfWeek`	`valueOf(String name)`
`static final DayOfWeek[]`	`values()`

Inherited methods

From class


        
          java.lang.Enum

`final Object`	`clone()` Throws CloneNotSupportedException.
`final int`	`compareTo(DayOfWeek o)` Compares this enum with the specified object for order.
`final boolean`	`equals(Object other)` Returns true if the specified object is equal to this enum constant.
`final void`	`finalize()` enum classes cannot have finalize methods.
`final Class<DayOfWeek>`	`getDeclaringClass()` Returns the Class object corresponding to this enum constant's enum type.
`final int`	`hashCode()` Returns a hash code for this enum constant.
`final String`	`name()` Returns the name of this enum constant, exactly as declared in its enum declaration.
`final int`	`ordinal()` Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
`String`	`toString()` Returns the name of this enum constant, as contained in the declaration.
`static <T extends Enum<T>> T`	`valueOf(Class<T> enumClass, String name)` Returns the enum constant of the specified enum class with the specified name.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(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`	`wait(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`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.lang.Comparable


      compareTo(DayOfWeek o)

Compares this object with the specified object for order.

From interface


        
          java.time.temporal.TemporalAccessor

`default int`	`get(TemporalField field)` Gets the value of the specified field as an `int`.
`abstract long`	`getLong(TemporalField field)` Gets the value of the specified field as a `long`.
`abstract boolean`	`isSupported(TemporalField field)` Checks if the specified field is supported.
`default <R> R`	`query(TemporalQuery<R> query)` Queries this date-time.
`default ValueRange`	`range(TemporalField field)` Gets the range of valid values for the specified field.

From interface


        
          java.time.temporal.TemporalAdjuster


        abstract
        
        
        
        
        Temporal


      adjustInto(Temporal temporal)

Adjusts the specified temporal object.

Enum values

FRIDAY

Added in API level 26

public static final DayOfWeek FRIDAY

The singleton instance for the day-of-week of Friday. This has the numeric value of 5.

MONDAY

Added in API level 26

public static final DayOfWeek MONDAY

The singleton instance for the day-of-week of Monday. This has the numeric value of 1.

SATURDAY

Added in API level 26

public static final DayOfWeek SATURDAY

The singleton instance for the day-of-week of Saturday. This has the numeric value of 6.

SUNDAY

Added in API level 26

public static final DayOfWeek SUNDAY

The singleton instance for the day-of-week of Sunday. This has the numeric value of 7.

THURSDAY

Added in API level 26

public static final DayOfWeek THURSDAY

The singleton instance for the day-of-week of Thursday. This has the numeric value of 4.

TUESDAY

Added in API level 26

public static final DayOfWeek TUESDAY

The singleton instance for the day-of-week of Tuesday. This has the numeric value of 2.

WEDNESDAY

Added in API level 26

public static final DayOfWeek WEDNESDAY

The singleton instance for the day-of-week of Wednesday. This has the numeric value of 3.

Public methods

adjustInto

Added in API level 26

public Temporal adjustInto (Temporal temporal)

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 TemporalAdjuster 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.

Parameters
`temporal`	`Temporal`: the target object to be adjusted, not null

Returns
`Temporal`	the adjusted object, not null

Throws
`DateTimeException`	if unable to make the adjustment
`ArithmeticException`	if numeric overflow occurs

from

Added in API level 26

public static DayOfWeek from (TemporalAccessor temporal)

Obtains an instance of DayOfWeek from a temporal object.

This obtains a day-of-week based on the specified temporal. A TemporalAccessor represents an arbitrary set of date and time information, which this factory converts to an instance of DayOfWeek.

The conversion extracts the DAY_OF_WEEK field.

This method matches the signature of the functional interface TemporalQuery allowing it to be used as a query via method reference, DayOfWeek::from.

Parameters
`temporal`	`TemporalAccessor`: the temporal object to convert, not null

Returns
`DayOfWeek`	the day-of-week, not null

Throws
`DateTimeException`	if unable to convert to a `DayOfWeek`

get

Added in API level 26

public int get (TemporalField field)

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

This queries this day-of-week for the value of 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 DAY_OF_WEEK then the value of the day-of-week, from 1 to 7, will be returned. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

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.

Parameters
`field`	`TemporalField`: the field to get, not null

Returns
`int`	the value for the field, within the valid range of values

Throws
`DateTimeException`	if a value for the field cannot be obtained or the value is outside the range of valid values for the field
`UnsupportedTemporalTypeException`	if the field is not supported or the range of values exceeds an `int`
`ArithmeticException`	if numeric overflow occurs

getDisplayName

Added in API level 26

public String getDisplayName (TextStyle style, 
                Locale locale)

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

This returns the textual name used to identify the day-of-week, suitable for presentation to the user. The parameters control the style of the returned text and the locale.

If no textual mapping is found then the numeric value is returned.

Parameters
`style`	`TextStyle`: the length of the text required, not null
`locale`	`Locale`: the locale to use, not null

Returns
`String`	the text value of the day-of-week, not null

getLong

Added in API level 26

public long getLong (TemporalField field)

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

This queries this day-of-week for the value of 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 DAY_OF_WEEK then the value of the day-of-week, from 1 to 7, will be returned. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

Parameters
`field`	`TemporalField`: the field to get, not null

Returns
`long`	the value for the field

Throws
`DateTimeException`	if a value for the field cannot be obtained
`UnsupportedTemporalTypeException`	if the field is not supported
`ArithmeticException`	if numeric overflow occurs

getValue

Added in API level 26

public int getValue ()

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
`int`	the day-of-week, from 1 (Monday) to 7 (Sunday)

isSupported

Added in API level 26

public boolean isSupported (TemporalField field)

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 and get methods will throw an exception.

If the field is 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.

Parameters
`field`	`TemporalField`: the field to check, null returns false

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

minus

Added in API level 26

public DayOfWeek minus (long days)

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.

Parameters
`days`	`long`: the days to subtract, positive or negative

Returns
`DayOfWeek`	the resulting day-of-week, not null

of

Added in API level 26

public static DayOfWeek of (int dayOfWeek)

Obtains an instance of DayOfWeek from an int value.

DayOfWeek is an enum representing the 7 days of the week. This factory allows the enum to be obtained from the int value. The int value follows the ISO-8601 standard, from 1 (Monday) to 7 (Sunday).

Parameters
`dayOfWeek`	`int`: the day-of-week to represent, from 1 (Monday) to 7 (Sunday)

Returns
`DayOfWeek`	the day-of-week singleton, not null

Throws
`DateTimeException`	if the day-of-week is invalid

plus

Added in API level 26

public DayOfWeek plus (long days)

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.

Parameters
`days`	`long`: the days to add, positive or negative

Returns
`DayOfWeek`	the resulting day-of-week, not null

query

Added in API level 26

public R query (TemporalQuery<R> 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.

Parameters
`query`	`TemporalQuery`: the query to invoke, not null

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

Throws
`DateTimeException`	if unable to query (defined by the query)
`ArithmeticException`	if numeric overflow occurs (defined by the query)

range

Added in API level 26

public ValueRange range (TemporalField 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 DAY_OF_WEEK then the range of the day-of-week, from 1 to 7, will be returned. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

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.

Parameters
`field`	`TemporalField`: the field to query the range for, not null

Returns
`ValueRange`	the range of valid values for the field, not null

Throws
`DateTimeException`	if the range for the field cannot be obtained
`UnsupportedTemporalTypeException`	if the field is not supported

valueOf

public static DayOfWeek valueOf (String name)

Parameters
`name`	`String`

Returns
`DayOfWeek`

values

public static final DayOfWeek[] values ()

Returns
`DayOfWeek[]`