Class DayOfYear

  • All Implemented Interfaces:
    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
    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.

    Implementation Requirements:

    This class is immutable and thread-safe.

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

    See Also:
    Serialized Form
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      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.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Method Detail

      • now

        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:
        the current day-of-year using the system clock and default time-zone, not null
      • now

        public static DayOfYear now​(java.time.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 - the zone ID to use, not null
        Returns:
        the current day-of-year using the system clock, not null
      • now

        public static DayOfYear now​(java.time.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 - the clock to use, not null
        Returns:
        the current day-of-year, not null
      • of

        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 - the day-of-year to represent, from 1 to 366
        Returns:
        the day-of-year, not null
        Throws:
        java.time.DateTimeException - if the day-of-year is invalid
      • from

        public static DayOfYear from​(java.time.temporal.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 - the temporal object to convert, not null
        Returns:
        the day-of-year, not null
        Throws:
        java.time.DateTimeException - if unable to convert to a DayOfYear
      • getValue

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

        public boolean isSupported​(java.time.temporal.TemporalField field)
        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.

        Specified by:
        isSupported in interface java.time.temporal.TemporalAccessor
        Parameters:
        field - the field to check, null returns false
        Returns:
        true if the field is supported on this day-of-year, false if not
      • range

        public java.time.temporal.ValueRange range​(java.time.temporal.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-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.

        Specified by:
        range in interface java.time.temporal.TemporalAccessor
        Parameters:
        field - the field to query the range for, not null
        Returns:
        the range of valid values for the field, not null
        Throws:
        java.time.DateTimeException - if the range for the field cannot be obtained
        java.time.temporal.UnsupportedTemporalTypeException - if the field is not supported
      • get

        public int get​(java.time.temporal.TemporalField field)
        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.

        Specified by:
        get in interface java.time.temporal.TemporalAccessor
        Parameters:
        field - the field to get, not null
        Returns:
        the value for the field
        Throws:
        java.time.DateTimeException - if a value for the field cannot be obtained or the value is outside the range of valid values for the field
        java.time.temporal.UnsupportedTemporalTypeException - if the field is not supported or the range of values exceeds an int
        java.lang.ArithmeticException - if numeric overflow occurs
      • getLong

        public long getLong​(java.time.temporal.TemporalField field)
        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.

        Specified by:
        getLong in interface java.time.temporal.TemporalAccessor
        Parameters:
        field - the field to get, not null
        Returns:
        the value for the field
        Throws:
        java.time.DateTimeException - if a value for the field cannot be obtained
        java.time.temporal.UnsupportedTemporalTypeException - if the field is not supported
        java.lang.ArithmeticException - if numeric overflow occurs
      • isValidYear

        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 - the year to validate
        Returns:
        true if the year is valid for this day-of-year
      • query

        public <R> R query​(java.time.temporal.TemporalQuery<R> 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.

        Specified by:
        query in interface java.time.temporal.TemporalAccessor
        Type Parameters:
        R - the type of the result
        Parameters:
        query - the query to invoke, not null
        Returns:
        the query result, null may be returned (defined by the query)
        Throws:
        java.time.DateTimeException - if unable to query (defined by the query)
        java.lang.ArithmeticException - if numeric overflow occurs (defined by the query)
      • adjustInto

        public java.time.temporal.Temporal adjustInto​(java.time.temporal.Temporal temporal)
        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.

        Specified by:
        adjustInto in interface java.time.temporal.TemporalAdjuster
        Parameters:
        temporal - the target object to be adjusted, not null
        Returns:
        the adjusted object, not null
        Throws:
        java.time.DateTimeException - if unable to make the adjustment
        java.lang.ArithmeticException - if numeric overflow occurs
      • atYear

        public java.time.LocalDate atYear​(java.time.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 - the year to use, not null
        Returns:
        the local date formed from this day and the specified year, not null
        Throws:
        java.time.DateTimeException - if the year is invalid or this is day 366 and the year is not a leap year
      • atYear

        public java.time.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 - the year to use, from MIN_YEAR to MAX_YEAR
        Returns:
        the local date formed from this day and the specified year, not null
        Throws:
        java.time.DateTimeException - if the year is invalid or this is day 366 and the year is not a leap year
      • compareTo

        public int compareTo​(DayOfYear other)
        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.

        Specified by:
        compareTo in interface java.lang.Comparable<DayOfYear>
        Parameters:
        other - the other day-of-year instance, not null
        Returns:
        the comparator value, negative if less, positive if greater
      • equals

        public boolean equals​(java.lang.Object obj)
        Checks if this day-of-year is equal to another day-of-year.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - the other day-of-year instance, null returns false
        Returns:
        true if the day-of-year is the same
      • hashCode

        public int hashCode()
        A hash code for this day-of-year.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        a suitable hash code
      • toString

        public java.lang.String toString()
        Outputs this day-of-year as a String.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of this day-of-year, not null