ThreeTen-Extra 1.8.0 · org.threeten.extra.DayOfYear · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final int	day The day-of-year being represented, from 1 to 366.
private static final long	serialVersionUID Serialization version.
private static final DayOfYear[]	VALUES Cache of singleton instances.

Access	Constructor and Description
private	DayOfYear(int the day-of-year to represent dayOfYear) Constructor.

Method Summary

Modifier and Type	Method and Description
public Temporal	Returns: the adjusted object, not null adjustInto(Temporal the target object to be adjusted, not null temporal) Implements java.time.temporal.TemporalAdjuster.adjustInto. Adjusts the specified temporal object to have this day-of-year.
public LocalDate	Returns: the local date formed from this day and the specified year, not null atYear(Year the year to use, not null year) Combines this day-of-year with a year to create a `LocalDate`.
public LocalDate	Returns: the local date formed from this day and the specified year, not null atYear(int the year to use, from MIN_YEAR to MAX_YEAR year) Combines this day-of-year with a year to create a `LocalDate`.
public int	Returns: the comparator value, negative if less, positive if greater compareTo(DayOfYear the other day-of-year instance, not null other) Implements java.lang.Comparable.compareTo. Compares this day-of-year to another.
public boolean	Returns: true if the day-of-year is the same equals(Object the other day-of-year instance, null returns false obj) Overrides java.lang.Object.equals. Checks if this day-of-year is equal to another day-of-year.
public static DayOfYear	Returns: the day-of-year, not null from(TemporalAccessor the temporal object to convert, not null temporal) Obtains an instance of `DayOfYear` from a date-time object.
public int	Returns: the value for the field get(TemporalField the field to get, not null field) Overrides default java.time.temporal.TemporalAccessor.get. Gets the value of the specified field from this day-of-year as an `int`.
public long	Returns: the value for the field getLong(TemporalField the field to get, not null field) Implements java.time.temporal.TemporalAccessor.getLong. Gets the value of the specified field from this day-of-year as a `long`.
public int	Returns: the day-of-year, from 1 to 366 getValue() Gets the day-of-year value.
public int	Returns: a suitable hash code hashCode() Overrides java.lang.Object.hashCode. A hash code for this day-of-year.
public boolean	Returns: true if the field is supported on this day-of-year, false if not isSupported(TemporalField the field to check, null returns false field) Implements java.time.temporal.TemporalAccessor.isSupported. Checks if the specified field is supported.
public boolean	Returns: true if the year is valid for this day-of-year isValidYear(int the year to validate year) Checks if the year is valid for this day-of-year.
public static DayOfYear	Returns: the current day-of-year using the system clock and default time-zone, not null now() Obtains the current day-of-year from the system clock in the default time-zone.
public static DayOfYear	Returns: the current day-of-year using the system clock, not null now(ZoneId the zone ID to use, not null zone) Obtains the current day-of-year from the system clock in the specified time-zone.
public static DayOfYear	Returns: the current day-of-year, not null now(Clock the clock to use, not null clock) Obtains the current day-of-year from the specified clock.
public static DayOfYear	Returns: the day-of-year, not null of(int the day-of-year to represent, from 1 to 366 dayOfYear) Obtains an instance of `DayOfYear`.
public < the type of the result R> R	Returns: the query result, null may be returned (defined by the query) query(TemporalQuery<R> the query to invoke, not null query) Overrides default java.time.temporal.TemporalAccessor.query. Queries this day-of-year using the specified query.
public ValueRange	Returns: the range of valid values for the field, not null range(TemporalField the field to query the range for, not null field) Overrides default java.time.temporal.TemporalAccessor.range. Gets the range of valid values for the specified field.
private Object	Returns: the valid object, not null readResolve() Validates the input.
public String	Returns: a string representation of this day-of-year, not null toString() Overrides java.lang.Object.toString. Outputs this day-of-year as a `String`.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

day	back to summary
private final int day The day-of-year being represented, from 1 to 366.

serialVersionUID	back to summary
private static final long serialVersionUID Serialization version.

VALUES	back to summary
private static final DayOfYear[] VALUES Cache of singleton instances.

DayOfYear	back to summary
private DayOfYear(int dayOfYear) Constructor. Parameters dayOfYear:int the day-of-year to represent

Method Detail

adjustInto back to summary

adjustInto	back to summary
public Temporal adjustInto(Temporal temporal) Implements java.time.temporal.TemporalAdjuster.adjustInto. 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(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. Parameters temporal:Temporal the target object to be adjusted, not null Returns:Temporal the adjusted object, not null Annotations @Override Exceptions DateTimeException: if unable to make the adjustment ArithmeticException: if numeric overflow occurs

public Temporal adjustInto(Temporal temporal)

Implements java.time.temporal.TemporalAdjuster.adjustInto.

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

Parameters

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

Returns:Temporal

the adjusted object, not null

Annotations

@Override

Exceptions

DateTimeException:: if unable to make the adjustment
ArithmeticException:: if numeric overflow occurs

atYear back to summary

atYear	back to summary
public LocalDate atYear(Year year) 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. Parameters year:Year the year to use, not null Returns:LocalDate the local date formed from this day and the specified year, not null Exceptions DateTimeException: if the year is invalid or this is day 366 and the year is not a leap year

public LocalDate atYear(Year year)

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.

Parameters

year:Year: the year to use, not null

Returns:LocalDate

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

Exceptions

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

atYear back to summary

atYear	back to summary
public LocalDate atYear(int year) 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. Parameters year:int the year to use, from MIN_YEAR to MAX_YEAR Returns:LocalDate the local date formed from this day and the specified year, not null Exceptions DateTimeException: if the year is invalid or this is day 366 and the year is not a leap year

public LocalDate atYear(int year)

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.

Parameters

year:int: the year to use, from MIN_YEAR to MAX_YEAR

Returns:LocalDate

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

Exceptions

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

compareTo back to summary

compareTo	back to summary
public int compareTo(DayOfYear other) Implements java.lang.Comparable.compareTo. 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`. Parameters other:DayOfYear the other day-of-year instance, not null Returns:int the comparator value, negative if less, positive if greater Annotations @Override

public int compareTo(DayOfYear other)

Implements java.lang.Comparable.compareTo.

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.

Parameters

other:DayOfYear: the other day-of-year instance, not null

Returns:int

the comparator value, negative if less, positive if greater

Annotations

@Override

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Checks if this day-of-year is equal to another day-of-year. Parameters obj:Object the other day-of-year instance, null returns false Returns:boolean true if the day-of-year is the same Annotations @Override

equals

back to summary

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

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

Parameters

obj:Object: the other day-of-year instance, null returns false

Returns:boolean

true if the day-of-year is the same

Annotations

@Override

from back to summary

from	back to summary
public static DayOfYear from(TemporalAccessor temporal) 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 `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`. Parameters temporal:TemporalAccessor the temporal object to convert, not null Returns:DayOfYear the day-of-year, not null Exceptions DateTimeException: if unable to convert to a `DayOfYear`

public static DayOfYear from(TemporalAccessor temporal)

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

Parameters

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

Returns:DayOfYear

the day-of-year, not null

Exceptions

DateTimeException:: if unable to convert to a DayOfYear

get back to summary

get	back to summary
public int get(TemporalField field) Overrides default java.time.temporal.TemporalAccessor.get. 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 `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. Parameters field:TemporalField the field to get, not null Returns:int the value for the field Annotations @Override Exceptions 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 int get(TemporalField field)

Overrides default java.time.temporal.TemporalAccessor.get.

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

Parameters

field:TemporalField: the field to get, not null

Returns:int

the value for the field

Annotations

@Override

Exceptions

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

getLong back to summary

getLong	back to summary
public long getLong(TemporalField field) Implements java.time.temporal.TemporalAccessor.getLong. 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 `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. Parameters field:TemporalField the field to get, not null Returns:long the value for the field Annotations @Override Exceptions DateTimeException: if a value for the field cannot be obtained UnsupportedTemporalTypeException: if the field is not supported ArithmeticException: if numeric overflow occurs

public long getLong(TemporalField field)

Implements java.time.temporal.TemporalAccessor.getLong.

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.

Parameters

field:TemporalField: the field to get, not null

Returns:long

the value for the field

Annotations

@Override

Exceptions

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

getValue	back to summary
public int getValue() Gets the day-of-year value. Returns:int the day-of-year, from 1 to 366

getValue

back to summary

public int getValue()

Gets the day-of-year value.

Returns:int: the day-of-year, from 1 to 366

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. A hash code for this day-of-year. Returns:int a suitable hash code Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

A hash code for this day-of-year.

Returns:int

a suitable hash code

Annotations

@Override

isSupported back to summary

isSupported	back to summary
public boolean isSupported(TemporalField field) Implements java.time.temporal.TemporalAccessor.isSupported. 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 `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` 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-year, false if not Annotations @Override

public boolean isSupported(TemporalField field)

Implements java.time.temporal.TemporalAccessor.isSupported.

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

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-year, false if not

Annotations

@Override

isValidYear	back to summary
public boolean isValidYear(int year) 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. Parameters year:int the year to validate Returns:boolean true if the year is valid for this day-of-year

isValidYear

back to summary

public boolean isValidYear(int year)

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.

Parameters

year:int: the year to validate

Returns:boolean

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

now back to summary

now	back to summary
public static DayOfYear now() Obtains the current day-of-year from the system clock in the default time-zone. 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. Returns:DayOfYear the current day-of-year using the system clock and default time-zone, not null

public static DayOfYear now()

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

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.

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

now back to summary

now	back to summary
public static DayOfYear now(ZoneId zone) Obtains the current day-of-year from the system clock in the specified time-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. Parameters zone:ZoneId the zone ID to use, not null Returns:DayOfYear the current day-of-year using the system clock, not null

public static DayOfYear now(ZoneId zone)

Obtains the current day-of-year from the system clock in the specified time-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.

Parameters

zone:ZoneId: the zone ID to use, not null

Returns:DayOfYear

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

now back to summary

now	back to summary
public static DayOfYear now(Clock clock) 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 `dependency injection`. Parameters clock:Clock the clock to use, not null Returns:DayOfYear the current day-of-year, not null

public static DayOfYear now(Clock clock)

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 dependency injection.

Parameters

clock:Clock: the clock to use, not null

Returns:DayOfYear

the current day-of-year, not null

of back to summary

of	back to summary
public static DayOfYear of(int dayOfYear) Obtains an instance of `DayOfYear`. A day-of-year object represents one of the 366 days of the year, from 1 to 366. Parameters dayOfYear:int the day-of-year to represent, from 1 to 366 Returns:DayOfYear the day-of-year, not null Exceptions DateTimeException: if the day-of-year is invalid

public static DayOfYear of(int dayOfYear)

Obtains an instance of DayOfYear.

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

Parameters

dayOfYear:int: the day-of-year to represent, from 1 to 366

Returns:DayOfYear

the day-of-year, not null

Exceptions

DateTimeException:: if the day-of-year is invalid

query back to summary

query	back to summary
public <R> R query(TemporalQuery<R> query) Overrides default java.time.temporal.TemporalAccessor.query. 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(TemporalAccessor)` method on the specified query passing `this` as the argument. Parameters <R> the type of the result query:TemporalQuery<R> the query to invoke, not null Returns:R the query result, null may be returned (defined by the query) Annotations @SuppressWarnings:unchecked @Override Exceptions DateTimeException: if unable to query (defined by the query) ArithmeticException: if numeric overflow occurs (defined by the query)

public <R> R query(TemporalQuery<R> query)

Overrides default java.time.temporal.TemporalAccessor.query.

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(TemporalAccessor) method on the specified query passing this as the argument.

Parameters

<R>: the type of the result
query:TemporalQuery<R>: the query to invoke, not null

Returns:R

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

Annotations

@SuppressWarnings:unchecked
@Override

Exceptions

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

range back to summary

range	back to summary
public ValueRange range(TemporalField field) Overrides default java.time.temporal.TemporalAccessor.range. 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 `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. Parameters field:TemporalField the field to query the range for, not null Returns:ValueRange the range of valid values for the field, not null Annotations @Override Exceptions DateTimeException: if the range for the field cannot be obtained UnsupportedTemporalTypeException: if the field is not supported

public ValueRange range(TemporalField field)

Overrides default java.time.temporal.TemporalAccessor.range.

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

Parameters

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

Returns:ValueRange

the range of valid values for the field, not null

Annotations

@Override

Exceptions

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

readResolve	back to summary
private Object readResolve() Validates the input. Returns:Object the valid object, not null

readResolve

back to summary

private Object readResolve()

Validates the input.

Returns:Object: the valid object, not null

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Outputs this day-of-year as a `String`. Returns:String a string representation of this day-of-year, not null Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Outputs this day-of-year as a String.

Returns:String

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

Annotations

@Override

public final Class DayOfYear

Implementation Requirements:

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail