Package org.threeten.bp.temporal

Enum JulianFields.Field

    • Field Detail

      • name

        private final java.lang.String name

      • offset

        private final long offset

    • Constructor Detail

    • Method Detail

      • values

        public static JulianFields.Field[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (JulianFields.Field c : JulianFields.Field.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static JulianFields.Field valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getBaseUnit

        public TemporalUnit getBaseUnit()
        Description copied from interface: TemporalField
        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 TemporalField.getRangeUnit().

        Specified by:
        getBaseUnit in interface TemporalField
        Returns:
        the period unit defining the base unit of the field, not null

      • getRangeUnit

        public TemporalUnit getRangeUnit()
        Description copied from interface: TemporalField
        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 TemporalField.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'.

        Specified by:
        getRangeUnit in interface TemporalField
        Returns:
        the period unit defining the range of the field, not null

      • range

        public ValueRange range()
        Description copied from interface: TemporalField
        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.

        Specified by:
        range in interface TemporalField
        Returns:
        the range of valid values for the field, not null

      • isDateBased

        public boolean isDateBased()
        Description copied from interface: TemporalField
        Checks if this field is date-based.

        A date-based field can be derived from epoch-day

        Specified by:
        isDateBased in interface TemporalField
        Returns:
        true if date-based

      • isTimeBased

        public boolean isTimeBased()
        Description copied from interface: TemporalField
        Checks if this field is time-based.

        A time-based field can be derived from nano-of-day

        Specified by:
        isTimeBased in interface TemporalField
        Returns:
        true if time-based

      • isSupportedBy

        public boolean isSupportedBy​(TemporalAccessor temporal)
        Description copied from interface: TemporalField
        Checks if this field is supported by the temporal object.

        This determines whether the temporal accessor supports this field. If this returns false, 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);
        It is recommended to use the second approach, isSupported(TemporalField), as it is a lot clearer to read in code.

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

        Specified by:
        isSupportedBy in interface TemporalField
        Parameters:
        temporal - the temporal object to query, not null
        Returns:
        true if the date-time can be queried for this field, false if not

      • rangeRefinedBy

        public ValueRange rangeRefinedBy​(TemporalAccessor temporal)
        Description copied from interface: TemporalField
        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 TemporalField.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);
        It is recommended to use the second approach, range(TemporalField), as it is a lot clearer to read in code.

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

        Specified by:
        rangeRefinedBy in interface TemporalField
        Parameters:
        temporal - the temporal object used to refine the result, not null
        Returns:
        the range of valid values for this field, not null

      • getFrom

        public long getFrom​(TemporalAccessor temporal)
        Description copied from interface: TemporalField
        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);
        It is recommended to use the second approach, getLong(TemporalField), as it is a lot clearer to read in code.

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

        Specified by:
        getFrom in interface TemporalField
        Parameters:
        temporal - the temporal object to query, not null
        Returns:
        the value of this field, not null

      • adjustInto

        public <R extends Temporal> R adjustInto​(R dateTime,
                                         long newValue)
        Description copied from interface: TemporalField
        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);
        It is recommended to use the second approach, with(TemporalField), as it is a lot clearer to read in code.

        Implementations should perform any queries or calculations using the fields available in ChronoField. If the field is not supported a DateTimeException 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.

        Specified by:
        adjustInto in interface TemporalField
        Type Parameters:
        R - the type of the Temporal object
        Parameters:
        dateTime - the temporal object to adjust, not null
        newValue - the new value of the field
        Returns:
        the adjusted temporal object, not null

      • getDisplayName

        public java.lang.String getDisplayName​(java.util.Locale locale)
        Description copied from interface: TemporalField
        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().

        Specified by:
        getDisplayName in interface TemporalField
        Parameters:
        locale - the locale to use, not null
        Returns:
        the display name for the locale or a suitable default, not null

      • resolve

        public TemporalAccessor resolve​(java.util.Map<TemporalField,​java.lang.Long> fieldValues,
                                TemporalAccessor partialTemporal,
                                ResolverStyle resolverStyle)
        Description copied from interface: TemporalField
        Resolves the date/time information in the builder

        This method is invoked during the resolve of the builder. Implementations should combine the associated field with others to form objects like LocalDate, LocalTime and LocalDateTime

        Specified by:
        resolve in interface TemporalField
        Parameters:
        fieldValues - the map of fields to values, which can be updated, not null
        partialTemporal - the partially complete temporal to query for zone and chronology; querying for other things is undefined and not recommended, not null
        resolverStyle - the requested type of resolve, not null
        Returns:
        the resolved temporal object; null if resolving only changed the map, or no resolve occurred

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<JulianFields.Field>