Implements java.time.temporal.TemporalField.adjustInto.

Doc from java.time.temporal.TemporalField.adjustInto.

Returns a copy of the specified temporal object with the value of this field set.

This returns a new temporal object based on the specified one with the value for this field changed. For example, on a LocalDate, this could be used to set the year, month or day-of-month. The returned object has the same observable type as the specified 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 implementation 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.

There are two equivalent ways of using this method. The first is to invoke this method directly. The second is to use Temporal#with(TemporalField, long):

  // these two lines are equivalent, but the second approach is recommended
  temporal = thisField.adjustInto(temporal);
  temporal = temporal.with(thisField);

Implementations should perform any queries or calculations using the fields available in ChronoField. If the field is not supported an UnsupportedTemporalTypeException must be thrown.

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

Parameters

<R>

the type of the Temporal object

temporal:R

the temporal object to adjust, not null

newValue:long

the new value of the field

Returns:R

the adjusted temporal object, not null

Annotations

@SuppressWarnings:unchecked

@Override

Implements java.time.temporal.TemporalField.getBaseUnit.

Doc from java.time.temporal.TemporalField.getBaseUnit.

Gets the unit that the field is measured in.

The unit of the field is the period that varies within the range. For example, in the field 'MonthOfYear', the unit is 'Months'. See also getRangeUnit().

Returns:TemporalUnit

the unit defining the base unit of the field, not null

Annotations

@Override

Implements java.time.temporal.TemporalField.getFrom.

Doc from java.time.temporal.TemporalField.getFrom.

Gets the value of this field from the specified temporal object.

This queries the temporal object for the value of this field.

There are two equivalent ways of using this method. The first is to invoke this method directly. The second is to use TemporalAccessor#getLong(TemporalField) (or TemporalAccessor#get(TemporalField)):

  // these two lines are equivalent, but the second approach is recommended
  temporal = thisField.getFrom(temporal);
  temporal = temporal.getLong(thisField);

Implementations should perform any queries or calculations using the fields available in ChronoField. If the field is not supported an UnsupportedTemporalTypeException must be thrown.

Parameters

temporal:TemporalAccessor

the temporal object to query, not null

Returns:long

the value of this field, not null

Annotations

@Override

Implements java.time.temporal.TemporalField.getRangeUnit.

Doc from java.time.temporal.TemporalField.getRangeUnit.

Gets the range that the field is bound by.

The range of the field is the period that the field varies within. For example, in the field 'MonthOfYear', the range is 'Years'. See also getBaseUnit().

The range is never null. For example, the 'Year' field is shorthand for 'YearOfForever'. It therefore has a unit of 'Years' and a range of 'Forever'.

Returns:TemporalUnit

the unit defining the range of the field, not null

Annotations

@Override

Implements java.time.temporal.TemporalField.isDateBased.

Doc from java.time.temporal.TemporalField.isDateBased.

Checks if this field represents a component of a date.

A field is date-based if it can be derived from EPOCH_DAY. Note that it is valid for both isDateBased() and isTimeBased() to return false, such as when representing a field like minute-of-week.

Returns:boolean

true if this field is a component of a date

Annotations

@Override

Implements java.time.temporal.TemporalField.isSupportedBy.

Doc from java.time.temporal.TemporalField.isSupportedBy.

Checks if this field is supported by the temporal object.

This determines whether the temporal accessor supports this field. If this returns false, then the temporal cannot be queried for this field.

There are two equivalent ways of using this method. The first is to invoke this method directly. The second is to use TemporalAccessor#isSupported(TemporalField):

  // these two lines are equivalent, but the second approach is recommended
  temporal = thisField.isSupportedBy(temporal);
  temporal = temporal.isSupported(thisField);

Implementations should determine whether they are supported using the fields available in ChronoField.

Parameters

temporal:TemporalAccessor

the temporal object to query, not null

Returns:boolean

true if the date-time can be queried for this field, false if not

Annotations

@Override

Implements java.time.temporal.TemporalField.isTimeBased.

Doc from java.time.temporal.TemporalField.isTimeBased.

Checks if this field represents a component of a time.

A field is time-based if it can be derived from NANO_OF_DAY. Note that it is valid for both isDateBased() and isTimeBased() to return false, such as when representing a field like minute-of-week.

Returns:boolean

true if this field is a component of a time

Annotations

@Override

Implements java.time.temporal.TemporalField.range.

Doc from java.time.temporal.TemporalField.range.

Gets the range of valid values for the field.

All fields can be expressed as a long integer. This method returns an object that describes the valid range for that value. This method is generally only applicable to the ISO-8601 calendar system.

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.

Returns:ValueRange

the range of valid values for the field, not null

Annotations

@Override

Implements java.time.temporal.TemporalField.rangeRefinedBy.

Doc from java.time.temporal.TemporalField.rangeRefinedBy.

Get the range of valid values for this field using the temporal object to refine the result.

This uses the temporal object to find the range of valid values for the field. This is similar to range(), however this method refines the result using the temporal. For example, if the field is DAY_OF_MONTH the range method is not accurate as there are four possible month lengths, 28, 29, 30 and 31 days. Using this method with a date allows the range to be accurate, returning just one of those four options.

There are two equivalent ways of using this method. The first is to invoke this method directly. The second is to use TemporalAccessor#range(TemporalField):

  // these two lines are equivalent, but the second approach is recommended
  temporal = thisField.rangeRefinedBy(temporal);
  temporal = temporal.range(thisField);

Implementations should perform any queries or calculations using the fields available in ChronoField. If the field is not supported an UnsupportedTemporalTypeException must be thrown.

Parameters

temporal:TemporalAccessor

the temporal object used to refine the result, not null

Returns:ValueRange

the range of valid values for this field, not null

Annotations

@Override

Overrides default java.time.temporal.TemporalField.resolve.

Doc from java.time.temporal.TemporalField.resolve.

Resolves this field to provide a simpler alternative or a date.

This method is invoked during the resolve phase of parsing. It is designed to allow application defined fields to be simplified into more standard fields, such as those on ChronoField, or into a date.

Applications should not normally invoke this method directly.

Parameters

fieldValues:Map<TemporalField, Long>

the map of fields to values, which can be updated, not null

partialTemporal:TemporalAccessor

the partially complete temporal to query for zone and chronology; querying for other things is undefined and not recommended, not null

resolverStyle:ResolverStyle

the requested type of resolve, not null

Returns:ChronoLocalDate

the resolved temporal object; null if resolving only changed the map, or no resolve occurred

Annotations

@Override

Overrides java.lang.Enum.toString.

Implements java.time.temporal.TemporalField.toString.

Doc from java.time.temporal.TemporalField.toString.

Gets a descriptive name for the field.

The should be of the format 'BaseOfRange', such as 'MonthOfYear', unless the field has a range of FOREVER, when only the base unit is mentioned, such as 'Year' or 'Era'.

Returns:String

the name of the field, not null

Annotations

@Override

Implements java.time.temporal.TemporalField.adjustInto.

Doc from java.time.temporal.TemporalField.adjustInto.

Returns a copy of the specified temporal object with the value of this field set.

This returns a new temporal object based on the specified one with the value for this field changed. For example, on a LocalDate, this could be used to set the year, month or day-of-month. The returned object has the same observable type as the specified 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 implementation 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.

There are two equivalent ways of using this method. The first is to invoke this method directly. The second is to use Temporal#with(TemporalField, long):

  // these two lines are equivalent, but the second approach is recommended
  temporal = thisField.adjustInto(temporal);
  temporal = temporal.with(thisField);

Implementations should perform any queries or calculations using the fields available in ChronoField. If the field is not supported an UnsupportedTemporalTypeException must be thrown.

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

Parameters

<R>

the type of the Temporal object

temporal:R

the temporal object to adjust, not null

newValue:long

the new value of the field

Returns:R

the adjusted temporal object, not null

Annotations

@SuppressWarnings:unchecked

@Override

Implements java.time.temporal.TemporalField.getBaseUnit.

Doc from java.time.temporal.TemporalField.getBaseUnit.

Gets the unit that the field is measured in.

The unit of the field is the period that varies within the range. For example, in the field 'MonthOfYear', the unit is 'Months'. See also getRangeUnit().

Returns:TemporalUnit

the unit defining the base unit of the field, not null

Annotations

@Override

Implements java.time.temporal.TemporalField.getFrom.

Doc from java.time.temporal.TemporalField.getFrom.

Gets the value of this field from the specified temporal object.

This queries the temporal object for the value of this field.

There are two equivalent ways of using this method. The first is to invoke this method directly. The second is to use TemporalAccessor#getLong(TemporalField) (or TemporalAccessor#get(TemporalField)):

  // these two lines are equivalent, but the second approach is recommended
  temporal = thisField.getFrom(temporal);
  temporal = temporal.getLong(thisField);

Implementations should perform any queries or calculations using the fields available in ChronoField. If the field is not supported an UnsupportedTemporalTypeException must be thrown.

Parameters

temporal:TemporalAccessor

the temporal object to query, not null

Returns:long

the value of this field, not null

Annotations

@Override

Implements java.time.temporal.TemporalField.getRangeUnit.

Doc from java.time.temporal.TemporalField.getRangeUnit.

Gets the range that the field is bound by.

The range of the field is the period that the field varies within. For example, in the field 'MonthOfYear', the range is 'Years'. See also getBaseUnit().

The range is never null. For example, the 'Year' field is shorthand for 'YearOfForever'. It therefore has a unit of 'Years' and a range of 'Forever'.

Returns:TemporalUnit

the unit defining the range of the field, not null

Annotations

@Override

Implements java.time.temporal.TemporalField.isDateBased.

Doc from java.time.temporal.TemporalField.isDateBased.

Checks if this field represents a component of a date.

A field is date-based if it can be derived from EPOCH_DAY. Note that it is valid for both isDateBased() and isTimeBased() to return false, such as when representing a field like minute-of-week.

Returns:boolean

true if this field is a component of a date

Annotations

@Override

Implements java.time.temporal.TemporalField.isSupportedBy.

Doc from java.time.temporal.TemporalField.isSupportedBy.

Checks if this field is supported by the temporal object.

This determines whether the temporal accessor supports this field. If this returns false, then the temporal cannot be queried for this field.

There are two equivalent ways of using this method. The first is to invoke this method directly. The second is to use TemporalAccessor#isSupported(TemporalField):

  // these two lines are equivalent, but the second approach is recommended
  temporal = thisField.isSupportedBy(temporal);
  temporal = temporal.isSupported(thisField);

Implementations should determine whether they are supported using the fields available in ChronoField.

Parameters

temporal:TemporalAccessor

the temporal object to query, not null

Returns:boolean

true if the date-time can be queried for this field, false if not

Annotations

@Override

Implements java.time.temporal.TemporalField.isTimeBased.

Doc from java.time.temporal.TemporalField.isTimeBased.

Checks if this field represents a component of a time.

A field is time-based if it can be derived from NANO_OF_DAY. Note that it is valid for both isDateBased() and isTimeBased() to return false, such as when representing a field like minute-of-week.

Returns:boolean

true if this field is a component of a time

Annotations

@Override

Implements java.time.temporal.TemporalField.range.

Doc from java.time.temporal.TemporalField.range.

Gets the range of valid values for the field.

All fields can be expressed as a long integer. This method returns an object that describes the valid range for that value. This method is generally only applicable to the ISO-8601 calendar system.

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.

Returns:ValueRange

the range of valid values for the field, not null

Annotations

@Override

Implements java.time.temporal.TemporalField.rangeRefinedBy.

Doc from java.time.temporal.TemporalField.rangeRefinedBy.

Get the range of valid values for this field using the temporal object to refine the result.

This uses the temporal object to find the range of valid values for the field. This is similar to range(), however this method refines the result using the temporal. For example, if the field is DAY_OF_MONTH the range method is not accurate as there are four possible month lengths, 28, 29, 30 and 31 days. Using this method with a date allows the range to be accurate, returning just one of those four options.

There are two equivalent ways of using this method. The first is to invoke this method directly. The second is to use TemporalAccessor#range(TemporalField):

  // these two lines are equivalent, but the second approach is recommended
  temporal = thisField.rangeRefinedBy(temporal);
  temporal = temporal.range(thisField);

Implementations should perform any queries or calculations using the fields available in ChronoField. If the field is not supported an UnsupportedTemporalTypeException must be thrown.

Parameters

temporal:TemporalAccessor

the temporal object used to refine the result, not null

Returns:ValueRange

the range of valid values for this field, not null

Annotations

@Override

Overrides java.lang.Enum.toString.

Implements java.time.temporal.TemporalField.toString.

Doc from java.time.temporal.TemporalField.toString.

Gets a descriptive name for the field.

The should be of the format 'BaseOfRange', such as 'MonthOfYear', unless the field has a range of FOREVER, when only the base unit is mentioned, such as 'Year' or 'Era'.

Returns:String

the name of the field, not null

Annotations

@Override

Unit that represents the concept of a week-based-year.

Implements java.time.temporal.TemporalUnit.addTo.

Doc from java.time.temporal.TemporalUnit.addTo.

Returns a copy of the specified temporal object with the specified period added.

The period added is a multiple of this unit. For example, this method could be used to add "3 days" to a date by calling this method on the instance representing "days", passing the date and the period "3". The period to be added may be negative, which is equivalent to subtraction.

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

  // these two lines are equivalent, but the second approach is recommended
  temporal = thisUnit.addTo(temporal);
  temporal = temporal.plus(thisUnit);

Implementations should perform any queries or calculations using the units available in ChronoUnit or the fields available in ChronoField. If the unit is not supported an UnsupportedTemporalTypeException must be thrown.

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

Parameters

<R>

the type of the Temporal object

temporal:R

the temporal object to adjust, not null

amount:long

the amount of this unit to add, positive or negative

Returns:R

the adjusted temporal object, not null

Annotations

@SuppressWarnings:unchecked

@Override

Implements java.time.temporal.TemporalUnit.between.

Doc from java.time.temporal.TemporalUnit.between.

Calculates the amount of time between two temporal objects.

This calculates the amount in terms of this unit. The start and end points are supplied as temporal objects and must be of compatible types. The implementation will convert the second type to be an instance of the first type before the calculating the amount. The result will be negative if the end is before the start. For example, the amount in hours between two temporal objects can be calculated using HOURS.between(startTime, endTime).

The calculation returns a whole number, representing the number of complete units between the two temporals. For example, the amount 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 Temporal#until(Temporal, TemporalUnit):

  // these two lines are equivalent
  between = thisUnit.between(start, end);
  between = start.until(end, thisUnit);

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

Implementations should perform any queries or calculations using the units available in ChronoUnit or the fields available in ChronoField. If the unit is not supported an UnsupportedTemporalTypeException must be thrown. Implementations must not alter the specified temporal objects.

Parameters

temporal1Inclusive:Temporal

the base temporal object, not null

temporal2Exclusive:Temporal

the other temporal object, exclusive, not null

Returns:long

the amount of time between temporal1Inclusive and temporal2Exclusive in terms of this unit; positive if temporal2Exclusive is later than temporal1Inclusive, negative if earlier

Annotations

@Override

Implements java.time.temporal.TemporalUnit.getDuration.

Doc from java.time.temporal.TemporalUnit.getDuration.

Gets the duration of this unit, which may be an estimate.

All units return a duration measured in standard nanoseconds from this method. The duration will be positive and non-zero. For example, an hour has a duration of 60 * 60 * 1,000,000,000ns.

Some units may return an accurate duration while others return an estimate. For example, days have an estimated duration due to the possibility of daylight saving time changes. To determine if the duration is an estimate, use isDurationEstimated().

Returns:Duration

the duration of this unit, which may be an estimate, not null

Annotations

@Override

Implements java.time.temporal.TemporalUnit.isDateBased.

Doc from java.time.temporal.TemporalUnit.isDateBased.

Checks if this unit represents a component of a date.

A date is time-based if it can be used to imply meaning from a date. It must have a duration that is an integral multiple of the length of a standard day. Note that it is valid for both isDateBased() and isTimeBased() to return false, such as when representing a unit like 36 hours.

Returns:boolean

true if this unit is a component of a date

Annotations

@Override

Implements java.time.temporal.TemporalUnit.isDurationEstimated.

Doc from java.time.temporal.TemporalUnit.isDurationEstimated.

Checks if the duration of the unit is an estimate.

All units have a duration, however the duration is not always accurate. For example, days have an estimated duration due to the possibility of daylight saving time changes. This method returns true if the duration is an estimate and false if it is accurate. Note that accurate/estimated ignores leap seconds.

Returns:boolean

true if the duration is estimated, false if accurate

Annotations

@Override

Overrides default java.time.temporal.TemporalUnit.isSupportedBy.

Doc from java.time.temporal.TemporalUnit.isSupportedBy.

Checks if this unit is supported by the specified temporal object.

This checks that the implementing date-time can add/subtract this unit. This can be used to avoid throwing an exception.

This default implementation derives the value using Temporal#plus(long, TemporalUnit).

Parameters

temporal:Temporal

the temporal object to check, not null

Returns:boolean

true if the unit is supported

Annotations

@Override

Implements java.time.temporal.TemporalUnit.isTimeBased.

Doc from java.time.temporal.TemporalUnit.isTimeBased.

Checks if this unit represents a component of a time.

A unit is time-based if it can be used to imply meaning from a time. It must have a duration that divides into the length of a standard day without remainder. Note that it is valid for both isDateBased() and isTimeBased() to return false, such as when representing a unit like 36 hours.

Returns:boolean

true if this unit is a component of a time

Annotations

@Override

Overrides java.lang.Enum.toString.

Implements java.time.temporal.TemporalUnit.toString.

Doc from java.time.temporal.TemporalUnit.toString.

Gets a descriptive name for the unit.

This should be in the plural and upper-first camel case, such as 'Days' or 'Minutes'.

Returns:String

the name of this unit, not null

Annotations

@Override