Package org.threeten.bp.temporal

Enum IsoFields.Unit

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private Duration duration  
      private java.lang.String name  

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Unit​(java.lang.String name, Duration estimatedDuration)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      <R extends Temporal>
      R      		 addTo​(R temporal, long periodToAdd)
      Returns a copy of the specified temporal object with the specified period added.
      long between​(Temporal temporal1, Temporal temporal2)
      Calculates the period in terms of this unit between two temporal objects of the same type.
      Duration getDuration()
      Gets the duration of this unit, which may be an estimate.
      boolean isDateBased()
      Checks if this unit is date-based.
      boolean isDurationEstimated()
      Checks if the duration of the unit is an estimate.
      boolean isSupportedBy​(Temporal temporal)
      Checks if this unit is supported by the specified temporal object.
      boolean isTimeBased()
      Checks if this unit is time-based.
      java.lang.String toString()
      Outputs this unit as a String using the name.
      static IsoFields.Unit valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static IsoFields.Unit[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • WEEK_BASED_YEARS

        public static final IsoFields.Unit WEEK_BASED_YEARS

    • Field Detail

      • name

        private final java.lang.String name

      • duration

        private final Duration duration

    • Constructor Detail

      • Unit

        private Unit​(java.lang.String name,
             Duration estimatedDuration)

    • Method Detail

      • values

        public static IsoFields.Unit[] 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 (IsoFields.Unit c : IsoFields.Unit.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static IsoFields.Unit 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

      • getDuration

        public Duration getDuration()
        Description copied from interface: TemporalUnit
        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 TemporalUnit.isDurationEstimated().

        Specified by:
        getDuration in interface TemporalUnit
        Returns:
        the duration of this unit, which may be an estimate, not null

      • isDurationEstimated

        public boolean isDurationEstimated()
        Description copied from interface: TemporalUnit
        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.

        Specified by:
        isDurationEstimated in interface TemporalUnit
        Returns:
        true if the duration is estimated, false if accurate

      • isDateBased

        public boolean isDateBased()
        Description copied from interface: TemporalUnit
        Checks if this unit is date-based.
        Specified by:
        isDateBased in interface TemporalUnit
        Returns:
        true if date-based

      • isTimeBased

        public boolean isTimeBased()
        Description copied from interface: TemporalUnit
        Checks if this unit is time-based.
        Specified by:
        isTimeBased in interface TemporalUnit
        Returns:
        true if time-based

      • isSupportedBy

        public boolean isSupportedBy​(Temporal temporal)
        Description copied from interface: TemporalUnit
        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.

        Specified by:
        isSupportedBy in interface TemporalUnit
        Parameters:
        temporal - the temporal object to check, not null
        Returns:
        true if the unit is supported

      • addTo

        public <R extends Temporal> R addTo​(R temporal,
                                    long periodToAdd)
        Description copied from interface: TemporalUnit
        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.doPlus(temporal);
   temporal = temporal.plus(thisUnit);
        It is recommended to use the second approach, plus(TemporalUnit), as it is a lot clearer to read in code.

        Implementations should perform any queries or calculations using the units available in ChronoUnit or 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:
        addTo in interface TemporalUnit
        Type Parameters:
        R - the type of the Temporal object
        Parameters:
        temporal - the temporal object to adjust, not null
        periodToAdd - the period of this unit to add, positive or negative
        Returns:
        the adjusted temporal object, not null

      • between

        public long between​(Temporal temporal1,
                    Temporal temporal2)
        Description copied from interface: TemporalUnit
        Calculates the period in terms of this unit between two temporal objects of the same type.

        This calculates the period between two temporals in terms of this unit. The start and end points are supplied as temporal objects and must be of the same type. 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 HOURS.between(startTime, endTime).

        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 b 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);
        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);
        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 a DateTimeException must be thrown. Implementations must not alter the specified temporal objects.
        Specified by:
        between in interface TemporalUnit
        Parameters:
        temporal1 - the base temporal object, not null
        temporal2 - the other temporal object, not null
        Returns:
        the period between temporal1 and temporal2 in terms of this unit; positive if temporal2 is later than temporal1, negative if earlier

      • toString

        public java.lang.String toString()
        Description copied from interface: TemporalUnit
        Outputs this unit as a String using the name.
        Specified by:
        toString in interface TemporalUnit
        Overrides:
        toString in class java.lang.Enum<IsoFields.Unit>
        Returns:
        the name of this unit, not null