java.io.Serializable
, java.lang.Comparable<DayOfYear>
, java.time.temporal.TemporalAccessor
, java.time.temporal.TemporalAdjuster
public final class DayOfYear extends java.lang.Object implements java.time.temporal.TemporalAccessor, java.time.temporal.TemporalAdjuster, java.lang.Comparable<DayOfYear>, java.io.Serializable
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.
This class must be treated as a value type. Do not synchronize, rely on the identity hash code or use the distinction between equals() and ==.
Modifier and Type | Method | Description |
---|---|---|
java.time.temporal.Temporal |
adjustInto(java.time.temporal.Temporal temporal) |
Adjusts the specified temporal object to have this day-of-year.
|
java.time.LocalDate |
atYear(int year) |
Combines this day-of-year with a year to create a
LocalDate . |
java.time.LocalDate |
atYear(java.time.Year year) |
Combines this day-of-year with a year to create a
LocalDate . |
int |
compareTo(DayOfYear other) |
Compares this day-of-year to another.
|
boolean |
equals(java.lang.Object obj) |
Checks if this day-of-year is equal to another day-of-year.
|
static DayOfYear |
from(java.time.temporal.TemporalAccessor temporal) |
Obtains an instance of
DayOfYear from a date-time object. |
int |
get(java.time.temporal.TemporalField field) |
Gets the value of the specified field from this day-of-year as an
int . |
long |
getLong(java.time.temporal.TemporalField field) |
Gets the value of the specified field from this day-of-year as a
long . |
int |
getValue() |
Gets the day-of-year value.
|
int |
hashCode() |
A hash code for this day-of-year.
|
boolean |
isSupported(java.time.temporal.TemporalField field) |
Checks if the specified field is supported.
|
boolean |
isValidYear(int year) |
Checks if the year is valid for this day-of-year.
|
static DayOfYear |
now() |
Obtains the current day-of-year from the system clock in the default time-zone.
|
static DayOfYear |
now(java.time.Clock clock) |
Obtains the current day-of-year from the specified clock.
|
static DayOfYear |
now(java.time.ZoneId zone) |
Obtains the current day-of-year from the system clock in the specified time-zone.
|
static DayOfYear |
of(int dayOfYear) |
Obtains an instance of
DayOfYear . |
<R> R |
query(java.time.temporal.TemporalQuery<R> query) |
Queries this day-of-year using the specified query.
|
java.time.temporal.ValueRange |
range(java.time.temporal.TemporalField field) |
Gets the range of valid values for the specified field.
|
java.lang.String |
toString() |
Outputs this day-of-year as a
String . |
public static DayOfYear now()
This will query the 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.
public static DayOfYear now(java.time.ZoneId zone)
This will query the 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.
zone
- the zone ID to use, not nullpublic static DayOfYear now(java.time.Clock 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 dependency injection
.
clock
- the clock to use, not nullpublic static DayOfYear of(int dayOfYear)
DayOfYear
.
A day-of-year object represents one of the 366 days of the year, from 1 to 366.
dayOfYear
- the day-of-year to represent, from 1 to 366java.time.DateTimeException
- if the day-of-year is invalidpublic static DayOfYear from(java.time.temporal.TemporalAccessor temporal)
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 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
.
temporal
- the temporal object to convert, not nulljava.time.DateTimeException
- if unable to convert to a DayOfYear
public int getValue()
public boolean isSupported(java.time.temporal.TemporalField field)
This checks if this day-of-year can be queried for the specified field.
If false, then calling the range
,
get
and getLong
methods will throw an exception.
If the field is a ChronoField
then the query is implemented here.
The supported fields are:
DAY_OF_YEAR
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.
isSupported
in interface java.time.temporal.TemporalAccessor
field
- the field to check, null returns falsepublic java.time.temporal.ValueRange range(java.time.temporal.TemporalField 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 supported fields
will return
appropriate range instances.
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.
range
in interface java.time.temporal.TemporalAccessor
field
- the field to query the range for, not nulljava.time.DateTimeException
- if the range for the field cannot be obtainedjava.time.temporal.UnsupportedTemporalTypeException
- if the field is not supportedpublic int get(java.time.temporal.TemporalField field)
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 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(TemporalAccessor)
passing this
as the argument. Whether the value can be obtained,
and what the value represents, is determined by the field.
get
in interface java.time.temporal.TemporalAccessor
field
- the field to get, not nulljava.time.DateTimeException
- if a value for the field cannot be obtained or
the value is outside the range of valid values for the fieldjava.time.temporal.UnsupportedTemporalTypeException
- if the field is not supported or
the range of values exceeds an int
java.lang.ArithmeticException
- if numeric overflow occurspublic long getLong(java.time.temporal.TemporalField field)
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 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(TemporalAccessor)
passing this
as the argument. Whether the value can be obtained,
and what the value represents, is determined by the field.
getLong
in interface java.time.temporal.TemporalAccessor
field
- the field to get, not nulljava.time.DateTimeException
- if a value for the field cannot be obtainedjava.time.temporal.UnsupportedTemporalTypeException
- if the field is not supportedjava.lang.ArithmeticException
- if numeric overflow occurspublic boolean isValidYear(int 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.
year
- the year to validatepublic <R> R query(java.time.temporal.TemporalQuery<R> 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(TemporalAccessor)
method on the
specified query passing this
as the argument.
query
in interface java.time.temporal.TemporalAccessor
R
- the type of the resultquery
- the query to invoke, not nulljava.time.DateTimeException
- if unable to query (defined by the query)java.lang.ArithmeticException
- if numeric overflow occurs (defined by the query)public java.time.temporal.Temporal adjustInto(java.time.temporal.Temporal temporal)
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(TemporalField, long)
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(TemporalAdjuster)
:
// 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.
adjustInto
in interface java.time.temporal.TemporalAdjuster
temporal
- the target object to be adjusted, not nulljava.time.DateTimeException
- if unable to make the adjustmentjava.lang.ArithmeticException
- if numeric overflow occurspublic java.time.LocalDate atYear(java.time.Year year)
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.
year
- the year to use, not nulljava.time.DateTimeException
- if the year is invalid or this is day 366 and the year is not a leap yearpublic java.time.LocalDate atYear(int year)
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.
year
- the year to use, from MIN_YEAR to MAX_YEARjava.time.DateTimeException
- if the year is invalid or this is day 366 and the year is not a leap yearpublic int compareTo(DayOfYear other)
The comparison is based on the value of the day.
It is "consistent with equals", as defined by Comparable
.
compareTo
in interface java.lang.Comparable<DayOfYear>
other
- the other day-of-year instance, not nullpublic boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- the other day-of-year instance, null returns falsepublic int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
String
.toString
in class java.lang.Object
Copyright © 2010–2018 ThreeTen.org. All rights reserved.