Package org.threeten.bp.chrono

Class ChronoLocalDateTimeImpl<D extends ChronoLocalDate>

  • Type Parameters:
    D - the date type
    All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ChronoLocalDateTime<?>>, Temporal, TemporalAccessor, TemporalAdjuster
    final class ChronoLocalDateTimeImpl<D extends ChronoLocalDate>
extends ChronoLocalDateTime<D>
implements Temporal, TemporalAdjuster, java.io.Serializable
    A date-time without a time-zone for the calendar neutral API.

    ChronoLocalDateTime is an immutable date-time object that represents a date-time, often viewed as year-month-day-hour-minute-second. This object can also access other fields such as day-of-year, day-of-week and week-of-year.

    This class stores all date and time fields, to a precision of nanoseconds. It does not store or represent a time-zone. For example, the value "2nd October 2007 at 13:45.30.123456789" can be stored in an ChronoLocalDateTime.

    Specification for implementors

    This class is immutable and thread-safe.

    • Constructor Detail

      • ChronoLocalDateTimeImpl

        private ChronoLocalDateTimeImpl​(D date,
                                LocalTime time)
        Constructor.
        Parameters:
        date - the date part of the date-time, not null
        time - the time part of the date-time, not null

    • Method Detail

      • of

        static <R extends ChronoLocalDate> ChronoLocalDateTimeImpl<R> of​(R date,
                                                                 LocalTime time)
        Obtains an instance of ChronoLocalDateTime from a date and time.
        Parameters:
        date - the local date, not null
        time - the local time, not null
        Returns:
        the local date-time, not null

      • with

        private ChronoLocalDateTimeImpl<D> with​(Temporal newDate,
                                        LocalTime newTime)
        Returns a copy of this date-time with the new date and time, checking to see if a new object is in fact required.
        Parameters:
        newDate - the date of the new date-time, not null
        newTime - the time of the new date-time, not null
        Returns:
        the date-time, not null

      • toLocalDate

        public D toLocalDate()
        Description copied from class: ChronoLocalDateTime
        Gets the local date part of this date-time.

        This returns a local date with the same year, month and day as this date-time.

        Specified by:
        toLocalDate in class ChronoLocalDateTime<D extends ChronoLocalDate>
        Returns:
        the date part of this date-time, not null

      • toLocalTime

        public LocalTime toLocalTime()
        Description copied from class: ChronoLocalDateTime
        Gets the local time part of this date-time.

        This returns a local time with the same hour, minute, second and nanosecond as this date-time.

        Specified by:
        toLocalTime in class ChronoLocalDateTime<D extends ChronoLocalDate>
        Returns:
        the time part of this date-time, not null

      • isSupported

        public boolean isSupported​(TemporalField field)
        Description copied from interface: TemporalAccessor
        Checks if the specified field is supported.

        This checks if the date-time can be queried for the specified field. If false, then calling the range and get methods will throw an exception.

        Specification for implementors

        Implementations must check and handle all fields defined in ChronoField. If the field is supported, then true is returned, otherwise 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.

        Implementations must not alter this object.

        Specified by:
        isSupported in interface TemporalAccessor
        Parameters:
        field - the field to check, null returns false
        Returns:
        true if this date-time can be queried for the field, false if not

      • isSupported

        public boolean isSupported​(TemporalUnit unit)
        Description copied from interface: Temporal
        Checks if the specified unit is supported.

        This checks if the date-time can be queried for the specified unit. If false, then calling the plus and minus methods will throw an exception.

        Specification for implementors

        Implementations must check and handle all fields defined in ChronoUnit. If the field is supported, then true is returned, otherwise false

        If the field is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.isSupportedBy(Temporal) passing this as the argument.

        Implementations must not alter this object.

        Specified by:
        isSupported in interface Temporal
        Parameters:
        unit - the unit to check, null returns false
        Returns:
        true if this date-time can be queried for the unit, false if not

      • range

        public ValueRange range​(TemporalField field)
        Description copied from interface: TemporalAccessor
        Gets the range of valid values for the specified field.

        All fields can be expressed as a long integer. This method returns an object that describes the valid range for that value. The value of this temporal object is used to enhance the accuracy of the returned range. If the date-time cannot return the range, because the field is unsupported or for some other reason, an exception will be thrown.

        Note that the result only describes the minimum and maximum valid values and it is important not to read too much into them. For example, there could be values within the range that are invalid for the field.

        Specification for implementors

        Implementations must check and handle all fields defined in ChronoField. If the field is supported, then the range of the field must be returned. If unsupported, then a DateTimeException must be thrown.

        If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.rangeRefinedBy(TemporalAccessorl) passing this as the argument.

        Implementations must not alter either this object.

        Specified by:
        range in interface TemporalAccessor
        Overrides:
        range in class DefaultInterfaceTemporalAccessor
        Parameters:
        field - the field to query the range for, not null
        Returns:
        the range of valid values for the field, not null

      • get

        public int get​(TemporalField field)
        Description copied from interface: TemporalAccessor
        Gets the value of the specified field as an int.

        This queries the date-time for the value for the specified field. The returned value will always be within the valid range of values for the field. If the date-time cannot return the value, because the field is unsupported or for some other reason, an exception will be thrown.

        Specification for implementors

        Implementations must check and handle all fields defined in ChronoField. If the field is supported and has an int range, then the value of the field must be returned. If unsupported, then a DateTimeException must be thrown.

        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.

        Implementations must not alter either this object.

        Specified by:
        get in interface TemporalAccessor
        Overrides:
        get in class DefaultInterfaceTemporalAccessor
        Parameters:
        field - the field to get, not null
        Returns:
        the value for the field, within the valid range of values

      • getLong

        public long getLong​(TemporalField field)
        Description copied from interface: TemporalAccessor
        Gets the value of the specified field as a long.

        This queries the date-time for the value for the specified field. The returned value may be outside the valid range of values for the field. If the date-time cannot return the value, because the field is unsupported or for some other reason, an exception will be thrown.

        Specification for implementors

        Implementations must check and handle all fields defined in ChronoField. If the field is supported, then the value of the field must be returned. If unsupported, then a DateTimeException must be thrown.

        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.

        Implementations must not alter either this object.

        Specified by:
        getLong in interface TemporalAccessor
        Parameters:
        field - the field to get, not null
        Returns:
        the value for the field

      • with

        public ChronoLocalDateTimeImpl<D> with​(TemporalAdjuster adjuster)
        Description copied from interface: Temporal
        Returns an adjusted object of the same type as this object with the adjustment made.

        This adjusts this date-time according to the rules of the specified adjuster. A simple adjuster might simply set the one of the fields, such as the year field. A more complex adjuster might set the date to the last day of the month. A selection of common adjustments is provided in TemporalAdjusters. These include finding the "last day of the month" and "next Wednesday". The adjuster is responsible for handling special cases, such as the varying lengths of month and leap years.

        Some example code indicating how and why this method is used: 

          date = date.with(Month.JULY);        // most key classes implement TemporalAdjuster
  date = date.with(lastDayOfMonth());  // static import from TemporalAdjusters
  date = date.with(next(WEDNESDAY));   // static import from TemporalAdjusters and DayOfWeek

        Specification for implementors

        Implementations must not alter either this object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
        Specified by:
        with in interface Temporal
        Overrides:
        with in class ChronoLocalDateTime<D extends ChronoLocalDate>
        Parameters:
        adjuster - the adjuster to use, not null
        Returns:
        an object of the same type with the specified adjustment made, not null

      • with

        public ChronoLocalDateTimeImpl<D> with​(TemporalField field,
                                       long newValue)
        Description copied from interface: Temporal
        Returns an object of the same type as this object with the specified field altered.

        This returns a new object based on this one with the value for the specified field changed. For example, on a LocalDate, this could be used to set the year, month or day-of-month. The returned object will have the same observable type as this object.

        In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st January, then changing the month to February would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.

        Specification for implementors

        Implementations must check and handle all fields defined in ChronoField. If the field is supported, then the adjustment must be performed. If unsupported, then a DateTimeException must be thrown.

        If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.adjustInto(Temporal, long) passing this as the first argument.

        Implementations must not alter either this object or the specified temporal object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.

        Specified by:
        with in interface Temporal
        Specified by:
        with in class ChronoLocalDateTime<D extends ChronoLocalDate>
        Parameters:
        field - the field to set in the result, not null
        newValue - the new value of the field in the result
        Returns:
        an object of the same type with the specified field set, not null

      • plus

        public ChronoLocalDateTimeImpl<D> plus​(long amountToAdd,
                                       TemporalUnit unit)
        Description copied from interface: Temporal
        Returns an object of the same type as this object with the specified period added.

        This method returns a new object based on this one with the specified period added. For example, on a LocalDate, this could be used to add a number of years, months or days. The returned object will have the same observable type as this object.

        In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st January, then adding one month would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.

        If the implementation represents a date-time that has boundaries, such as LocalTime, then the permitted units must include the boundary unit, but no multiples of the boundary unit. For example, LocalTime must accept DAYS but not WEEKS or MONTHS.

        Specification for implementors

        Implementations must check and handle all units defined in ChronoUnit. If the unit is supported, then the addition must be performed. If unsupported, then a DateTimeException must be thrown.

        If the unit is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.addTo(Temporal, long) passing this as the first argument.

        Implementations must not alter either this object or the specified temporal object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.

        Specified by:
        plus in interface Temporal
        Specified by:
        plus in class ChronoLocalDateTime<D extends ChronoLocalDate>
        Parameters:
        amountToAdd - the amount of the specified unit to add, may be negative
        unit - the unit of the period to add, not null
        Returns:
        an object of the same type with the specified period added, not null

      • plusWithOverflow

        private ChronoLocalDateTimeImpl<D> plusWithOverflow​(D newDate,
                                                    long hours,
                                                    long minutes,
                                                    long seconds,
                                                    long nanos)

      • atZone

        public ChronoZonedDateTime<D> atZone​(ZoneId zoneId)
        Description copied from class: ChronoLocalDateTime
        Combines this time with a time-zone to create a ChronoZonedDateTime.

        This returns a ChronoZonedDateTime formed from this date-time at the specified time-zone. The result will match this date-time as closely as possible. Time-zone rules, such as daylight savings, mean that not every local date-time is valid for the specified zone, thus the local date-time may be adjusted.

        The local date-time is resolved to a single instant on the time-line. This is achieved by finding a valid offset from UTC/Greenwich for the local date-time as defined by the rules of the zone ID.

        In most cases, there is only one valid offset for a local date-time. In the case of an overlap, where clocks are set back, there are two valid offsets. This method uses the earlier offset typically corresponding to "summer".

        In the case of a gap, where clocks jump forward, there is no valid offset. Instead, the local date-time is adjusted to be later by the length of the gap. For a typical one hour daylight savings change, the local date-time will be moved one hour later into the offset typically corresponding to "summer".

        To obtain the later offset during an overlap, call ChronoZonedDateTime.withLaterOffsetAtOverlap() on the result of this method.

        Specified by:
        atZone in class ChronoLocalDateTime<D extends ChronoLocalDate>
        Parameters:
        zoneId - the time-zone to use, not null
        Returns:
        the zoned date-time formed from this date-time, not null

      • until

        public long until​(Temporal endExclusive,
                  TemporalUnit unit)
        Description copied from interface: Temporal
        Calculates the period between this temporal and another temporal in terms of the specified unit.

        This calculates the period between two temporals in terms of a single unit. The start and end points are this and the specified temporal. The result will be negative if the end is before the start. For example, the period in hours between two temporal objects can be calculated using startTime.until(endTime, HOURS).

        The calculation returns a whole number, representing the number of complete units between the two temporals. For example, the period in hours between the times 11:30 and 13:29 will only be one hour as it is one minute short of two hours.

        There are two equivalent ways of using this method. The first is to invoke this method directly. The second is to use TemporalUnit.between(Temporal, Temporal): 

           // these two lines are equivalent
   between = thisUnit.between(start, end);
   between = start.until(end, thisUnit);
        The choice should be made based on which makes the code more readable.

        For example, this method allows the number of days between two dates to be calculated: 

           long daysBetween = DAYS.between(start, end);
   // or alternatively
   long daysBetween = start.until(end, DAYS);

        Specification for implementors

        Implementations must begin by checking to ensure that the input temporal object is of the same observable type as the implementation. They must then perform the calculation for all instances of ChronoUnit. A DateTimeException must be thrown for ChronoUnit instances that are unsupported.

        If the unit is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.between(Temporal, Temporal) passing this as the first argument and the input temporal as the second argument.

        In summary, implementations must behave in a manner equivalent to this code: 

          // check input temporal is the same type as this class
  if (unit instanceof ChronoUnit) {
    // if unit is supported, then calculate and return result
    // else throw DateTimeException for unsupported units
  }
  return unit.between(this, endTemporal);

        The target object must not be altered by this method.

        Specified by:
        until in interface Temporal
        Parameters:
        endExclusive - the end temporal, of the same type as this object, not null
        unit - the unit to measure the period in, not null
        Returns:
        the amount of the period between this and the end

      • writeReplace

        private java.lang.Object writeReplace()

      • writeExternal

        void writeExternal​(java.io.ObjectOutput out)
            throws java.io.IOException
        Throws:
        java.io.IOException

      • readExternal

        static ChronoLocalDateTime<?> readExternal​(java.io.ObjectInput in)
                                    throws java.io.IOException,
                                           java.lang.ClassNotFoundException
        Throws:
        java.io.IOException
        java.lang.ClassNotFoundException