TemporalField

adjustInto

abstract fun <R : Temporal!> adjustInto(
    temporal: R, 
    newValue: Long
): R

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.

getBaseUnit

abstract fun getBaseUnit(): TemporalUnit!

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

getDisplayName

open fun getDisplayName(locale: Locale!): String!

Gets the display name for the field in the requested locale.

If there is no display name for the locale then a suitable default must be returned.

The default implementation must check the locale is not null and return toString().

getFrom

abstract fun getFrom(temporal: TemporalAccessor!): Long

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.

getRangeUnit

abstract fun getRangeUnit(): TemporalUnit!

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

isDateBased

abstract fun isDateBased(): Boolean

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.

isSupportedBy

abstract fun isSupportedBy(temporal: TemporalAccessor!): Boolean

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.

isTimeBased

abstract fun isTimeBased(): Boolean

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.

range

abstract fun range(): ValueRange!

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.

rangeRefinedBy

abstract fun rangeRefinedBy(temporal: TemporalAccessor!): ValueRange!

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.

resolve

open fun resolve(
    fieldValues: MutableMap<TemporalField!, Long!>!, 
    partialTemporal: TemporalAccessor!, 
    resolverStyle: ResolverStyle!
): TemporalAccessor!

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.