Home Reference Source
public class | source

DayOfYear

Extends:

@js-joda/core~TemporalAccessor → DayOfYear

A day-of-year in the ISO-8601 calendar system.

DayOfYear is an immutable date-time object that represents a day-of-year. It is a type-safe way of representing a day-of-year in an application. Any field that can be derived from a day-of-year can be obtained.

This class does not store or represent a year, month, time or time-zone. For example, the value "51" can be stored in a DayOfYear and would represent the 51st day of any year.

Static Method Summary

Static Public Methods
public static

from(temporal: Temporal): DayOfYear

Obtains an instance of DayOfYear from a date-time object.

public static

now(zoneIdOrClock: ZoneId | Clock): DayOfYear

Function overloading for DayOfYear.now:

public static

of(dayOfYear: number): DayOfYear

Obtains an instance of DayOfYear.

Static Protected Methods
protected static

Obtains the current day-of-year from the system clock in the default time-zone.

protected static

Obtains the current day-of-year from the specified clock.

protected static

Obtains the current day-of-year from the system clock in the specified time-zone.

Method Summary

Public Methods
public

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

public

atYear(year: Year | number): LocalDate

Combines this day-of-year with a year to create a LocalDate.

public

compareTo(other: DayOfYear): number

Compares this day-of-year to another.

public

equals(obj: *): boolean

Checks if this day-of-year is equal to another day-of-year.

public

get(field: TemporalField): number

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

public

getLong(field: TemporalField): number

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

public

hashCode(): number

A hash code for this day-of-year.

public

isSupported(field: TemporalField): boolean

Checks if the specified field is supported.

public

isValidYear(year: number): boolean

Checks if the year is valid for this day-of-year.

public

query(query: TemporalQuery): *

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

public

Gets the range of valid values for the specified field.

public

toString(): string

Outputs this day-of-year as a String.

public

value(): number

Gets the day-of-year value.

Static Public Methods

public static from(temporal: Temporal): DayOfYear source

Obtains an instance of DayOfYear from a date-time object.

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

The conversion extracts the ChronoField.DAY_OF_YEAR day-of-year field. The extraction is only permitted if the temporal object has an ISO chronology, or can be converted to a LocalDate.

This method matches the signature of the functional interface TemporalQuery allowing it to be used in queries via method reference, DayOfYear.from.

Params:

NameTypeAttributeDescription
temporal Temporal

the temporal object to convert, not null

Return:

DayOfYear

the day-of-year, not null

Throw:

DateTimeException

if unable to convert to a DayOfYear

public static now(zoneIdOrClock: ZoneId | Clock): DayOfYear source

Function overloading for DayOfYear.now:

Params:

NameTypeAttributeDescription
zoneIdOrClock ZoneId | Clock
  • nullable: true

Return:

DayOfYear

public static of(dayOfYear: number): DayOfYear source

Obtains an instance of DayOfYear.

A day-of-year object represents one of the 366 days of the year, from 1 to 366.

Params:

NameTypeAttributeDescription
dayOfYear number

the day-of-year to represent, from 1 to 366

Return:

DayOfYear

the day-of-year, not null

Throw:

DateTimeException

if the day-of-year is invalid

Static Protected Methods

protected static _now0(): DayOfYear source

Obtains the current day-of-year from the system clock in the default time-zone.

This will query the Clock.systemDefaultZone system clock in the default time-zone to obtain the current day-of-year. The zone and offset will be set based on the time-zone in the clock.

Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

Return:

DayOfYear

the current day-of-year using the system clock and default time-zone, not null

protected static _nowClock(clock: Clock): DayOfYear source

Obtains the current day-of-year from the specified clock.

This will query the specified clock to obtain the current day-of-year. Using this method allows the use of an alternate clock for testing. The alternate clock may be introduced using Clock dependency injection.

Params:

NameTypeAttributeDescription
clock Clock

the clock to use, not null

Return:

DayOfYear

the current day-of-year, not null

protected static _nowZoneId(zone: ZoneId): DayOfYear source

Obtains the current day-of-year from the system clock in the specified time-zone.

This will query the Clock.system system clock to obtain the current day-of-year. Specifying the time-zone avoids dependence on the default time-zone.

Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

Params:

NameTypeAttributeDescription
zone ZoneId

the zone ID to use, not null

Return:

DayOfYear

the current day-of-year using the system clock, not null

Public Methods

public adjustInto(temporal: Temporal): Temporal source

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

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

The adjustment is equivalent to using Temporal.with passing ChronoField.DAY_OF_YEAR as the field. If the specified temporal object does not use the ISO calendar system then a DateTimeException is thrown.

In most cases, it is clearer to reverse the calling pattern by using Temporal.with:

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

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
temporal Temporal

the target object to be adjusted, not null

Return:

Temporal

the adjusted object, not null

Throw:

DateTimeException

if unable to make the adjustment

ArithmeticException

if numeric overflow occurs

public atYear(year: Year | number): LocalDate source

Combines this day-of-year with a year to create a LocalDate.

This returns a LocalDate formed from this day and the specified year.

This method can be used as part of a chain to produce a date:

 LocalDate date = day.atYear(year);

The day-of-year value 366 is only valid in a leap year.

Params:

NameTypeAttributeDescription
year Year | number

the year to use (Year or int), not null

Return:

LocalDate

the local date formed from this day and the specified year, not null

Throw:

DateTimeException

if the year is invalid or this is day 366 and the year is not a leap year

public compareTo(other: DayOfYear): number source

Compares this day-of-year to another.

The comparison is based on the value of the day. It is "consistent with equals", as defined by Comparable.

Params:

NameTypeAttributeDescription
other DayOfYear

the other day-of-year instance, not null

Return:

number

the comparator value, negative if less, positive if greater

public equals(obj: *): boolean source

Checks if this day-of-year is equal to another day-of-year.

Params:

NameTypeAttributeDescription
obj *

the other day-of-year instance, null returns false

Return:

boolean

true if the day-of-year is the same

public get(field: TemporalField): number source

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

This queries this day-of-year 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 a ChronoField then the query is implemented here. The DayOfYear.isSupported supported fields will return valid values based on this day-of-year. 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 passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

Params:

NameTypeAttributeDescription
field TemporalField

the field to get, not null

Return:

number

the value for the field

Throw:

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

public getLong(field: TemporalField): number source

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

This queries this day-of-year 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 a ChronoField then the query is implemented here. The DayOfYear.isSupported supported fields will return valid values based on this day-of-year. All other {@code 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 passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

Params:

NameTypeAttributeDescription
field TemporalField

the field to get, not null

Return:

number

the value for the field

Throw:

DateTimeException

if a value for the field cannot be obtained

UnsupportedTemporalTypeException

if the field is not supported

ArithmeticException

if numeric overflow occurs

public hashCode(): number source

A hash code for this day-of-year.

Return:

number

a suitable hash code

public isSupported(field: TemporalField): boolean source

Checks if the specified field is supported.

This checks if this day-of-year can be queried for the specified field. If false, then calling the DayOfYear.range range, DayOfYear.get get and DayOfYear.getLong getLong methods will throw an exception.

If the field is a ChronoField then the query is implemented here. The supported fields are:

  • ChronoField.DAY_OF_YEAR

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 passing this as the argument. Whether the field is supported is determined by the field.

Params:

NameTypeAttributeDescription
field TemporalField

the field to check, null returns false

Return:

boolean

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

public isValidYear(year: number): boolean source

Checks if the year is valid for this day-of-year.

This method checks whether this day-of-yearand the input year form a valid date. This can only return false for day-of-year 366.

Params:

NameTypeAttributeDescription
year number

the year to validate

Return:

boolean

true if the year is valid for this day-of-year

public query(query: TemporalQuery): * source

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

This queries this day-of-year 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 method on the specified query passing this as the argument.

Params:

NameTypeAttributeDescription
query TemporalQuery

the query to invoke, not null

Return:

*

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

Throw:

DateTimeException

if unable to query (defined by the query)

ArithmeticException

if numeric overflow occurs (defined by the query)

public range(field: TemporalField): ValueRange source

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-year 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 a ChronoField then the query is implemented here. The DayOfYear.isSupported supported fields will return appropriate range instances. All other {@code 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 passing this as the argument. Whether the range can be obtained is determined by the field.

Params:

NameTypeAttributeDescription
field TemporalField

the field to query the range for, not null

Return:

ValueRange

the range of valid values for the field, not null

Throw:

DateTimeException

if the range for the field cannot be obtained

UnsupportedTemporalTypeException

if the field is not supported

public toString(): string source

Outputs this day-of-year as a String.

Return:

string

a string representation of this day-of-year, not null

public value(): number source

Gets the day-of-year value.

Return:

number

the day-of-year, from 1 to 366