C - the chronology of this date-timepublic interface ChronoLocalDateTime<C extends Chrono<C>> extends Temporal, TemporalAdjuster, Comparable<ChronoLocalDateTime<?>>
Most applications should declare method signatures, fields and variables
as LocalDateTime, not this interface.
A ChronoLocalDateTime is the abstract representation of a local date-time
where the Chrono chronology, or calendar system, is pluggable.
The date-time is defined in terms of fields expressed by TemporalField,
where most common implementations are defined in ChronoField.
The chronology defines how the calendar system operates and the meaning of
the standard fields.
LocalDateTime rather than this
interface, even in the case where the application needs to deal with multiple
calendar systems. The rationale for this is explored in detail in ChronoLocalDate.
Ensure that the discussion in ChronoLocalDate has been read and understood
before using this interface.
| Modifier and Type | Field and Description |
|---|---|
static Comparator<ChronoLocalDateTime<?>> |
DATE_TIME_COMPARATOR
Comparator for two
ChronoLocalDateTime instances ignoring the chronology. |
| Modifier and Type | Method and Description |
|---|---|
ChronoZonedDateTime<C> |
atZone(ZoneId zone)
Returns a zoned date-time formed from this date-time and the specified time-zone.
|
int |
compareTo(ChronoLocalDateTime<?> other)
Compares this date-time to another date-time, including the chronology.
|
boolean |
equals(Object obj)
Checks if this date-time is equal to another date-time, including the chronology.
|
ChronoLocalDate<C> |
getDate()
Gets the local date part of this date-time.
|
LocalTime |
getTime()
Gets the local time part of this date-time.
|
int |
hashCode()
A hash code for this date-time.
|
boolean |
isAfter(ChronoLocalDateTime<?> other)
Checks if this date-time is after the specified date-time ignoring the chronology.
|
boolean |
isBefore(ChronoLocalDateTime<?> other)
Checks if this date-time is before the specified date-time ignoring the chronology.
|
boolean |
isEqual(ChronoLocalDateTime<?> other)
Checks if this date-time is equal to the specified date-time ignoring the chronology.
|
ChronoLocalDateTime<C> |
minus(long amountToSubtract,
TemporalUnit unit)
Returns an object of the same type as this object with the specified period subtracted.
|
ChronoLocalDateTime<C> |
minus(TemporalSubtractor adjuster)
Returns an object of the same type as this object with an amount subtracted.
|
ChronoLocalDateTime<C> |
plus(long amountToAdd,
TemporalUnit unit)
Returns an object of the same type as this object with the specified period added.
|
ChronoLocalDateTime<C> |
plus(TemporalAdder adjuster)
Returns an object of the same type as this object with an amount added.
|
long |
toEpochSecond(ZoneOffset offset)
Converts this date-time to the number of seconds from the epoch
of 1970-01-01T00:00:00Z.
|
Instant |
toInstant(ZoneOffset offset)
Converts this date-time to an
Instant. |
String |
toString()
Outputs this date-time as a
String. |
String |
toString(DateTimeFormatter formatter)
Outputs this date-time as a
String using the formatter. |
ChronoLocalDateTime<C> |
with(TemporalAdjuster adjuster)
Returns an adjusted object of the same type as this object with the adjustment made.
|
ChronoLocalDateTime<C> |
with(TemporalField field,
long newValue)
Returns an object of the same type as this object with the specified field altered.
|
periodUntilget, getLong, isSupported, query, rangeadjustIntostatic final Comparator<ChronoLocalDateTime<?>> DATE_TIME_COMPARATOR
ChronoLocalDateTime instances ignoring the chronology.
This method differs from the comparison in compareTo(org.threeten.bp.temporal.ChronoLocalDateTime<?>) in that it
only compares the underlying date and not the chronology.
This allows dates in different calendar systems to be compared based
on the time-line position.
ChronoLocalDate<C> getDate()
This returns a local date with the same year, month and day as this date-time.
LocalTime getTime()
This returns a local time with the same hour, minute, second and nanosecond as this date-time.
ChronoLocalDateTime<C> with(TemporalAdjuster adjuster)
Temporal
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
ChronoLocalDateTime<C> with(TemporalField field, long newValue)
Temporal
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.
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.doWith(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.
ChronoLocalDateTime<C> plus(TemporalAdder adjuster)
Temporal
This adjusts this temporal, adding according to the rules of the specified adder.
The adder is typically a Period but may be any other type implementing
the TemporalAdder interface, such as Duration.
Some example code indicating how and why this method is used:
date = date.plus(period); // add a Period instance date = date.plus(duration); // add a Duration instance date = date.plus(MONTHS.between(start, end)); // static import of MONTHS field date = date.plus(workingDays(6)); // example user-written workingDays method
Note that calling plus followed by minus is not guaranteed to
return the same date-time.
ChronoLocalDateTime<C> plus(long amountToAdd, TemporalUnit unit)
Temporal
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.
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.doPlus(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.
ChronoLocalDateTime<C> minus(TemporalSubtractor adjuster)
Temporal
This adjusts this temporal, subtracting according to the rules of the specified subtractor.
The subtractor is typically a Period but may be any other type implementing
the TemporalSubtractor interface, such as Duration.
Some example code indicating how and why this method is used:
date = date.minus(period); // subtract a Period instance date = date.minus(duration); // subtract a Duration instance date = date.minus(MONTHS.between(start, end)); // static import of MONTHS field date = date.minus(workingDays(6)); // example user-written workingDays method
Note that calling plus followed by minus is not guaranteed to
return the same date-time.
ChronoLocalDateTime<C> minus(long amountToSubtract, TemporalUnit unit)
Temporal
This method returns a new object based on this one with the specified period subtracted.
For example, on a LocalDate, this could be used to subtract 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 March, then subtracting 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.
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.
ChronoZonedDateTime<C> atZone(ZoneId zone)
This creates a zoned date-time matching the input 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.
This instance is immutable and unaffected by this method call.
zone - the time-zone to use, not nullInstant toInstant(ZoneOffset offset)
Instant.
This combines this local date-time and the specified offset to form
an Instant.
offset - the offset to use for the conversion, not nullInstant representing the same instant, not nulllong toEpochSecond(ZoneOffset offset)
This combines this local date-time and the specified offset to calculate the epoch-second value, which is the number of elapsed seconds from 1970-01-01T00:00:00Z. Instants on the time-line after the epoch are positive, earlier are negative.
offset - the offset to use for the conversion, not nullint compareTo(ChronoLocalDateTime<?> other)
The comparison is based first on the underlying time-line date-time, then
on the chronology.
It is "consistent with equals", as defined by Comparable.
For example, the following is the comparator order:
2012-12-03T12:00 (ISO)2012-12-04T12:00 (ISO)2555-12-04T12:00 (ThaiBuddhist)2012-12-05T12:00 (ISO)If all the date-time objects being compared are in the same chronology, then the additional chronology stage is not required and only the local date-time is used.
compareTo in interface Comparable<ChronoLocalDateTime<?>>other - the other date-time to compare to, not nullboolean isAfter(ChronoLocalDateTime<?> other)
This method differs from the comparison in compareTo(org.threeten.bp.temporal.ChronoLocalDateTime<?>) in that it
only compares the underlying date-time and not the chronology.
This allows dates in different calendar systems to be compared based
on the time-line position.
other - the other date-time to compare to, not nullboolean isBefore(ChronoLocalDateTime<?> other)
This method differs from the comparison in compareTo(org.threeten.bp.temporal.ChronoLocalDateTime<?>) in that it
only compares the underlying date-time and not the chronology.
This allows dates in different calendar systems to be compared based
on the time-line position.
other - the other date-time to compare to, not nullboolean isEqual(ChronoLocalDateTime<?> other)
This method differs from the comparison in compareTo(org.threeten.bp.temporal.ChronoLocalDateTime<?>) in that it
only compares the underlying date and time and not the chronology.
This allows date-times in different calendar systems to be compared based
on the time-line position.
other - the other date-time to compare to, not nullboolean equals(Object obj)
Compares this date-time with another ensuring that the date-time and chronology are the same.
int hashCode()
String toString()
String.
The output will include the full local date-time and the chronology ID.
String toString(DateTimeFormatter formatter)
String using the formatter.formatter - the formatter to use, not nullDateTimeException - if an error occurs during printingCopyright © 2007-2013 ThreeTen.org. All Rights Reserved.