org.threeten.bp.temporal

ChronoUnit

final class ChronoUnit extends Enum[ChronoUnit] with TemporalUnit

Linear Supertypes
TemporalUnit, Enum[ChronoUnit], Serializable, Comparable[ChronoUnit], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ChronoUnit
  2. TemporalUnit
  3. Enum
  4. Serializable
  5. Comparable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def addTo[R <: Temporal](dateTime: R, periodToAdd: Long): R

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

    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.

    R

    the type of the Temporal object

    dateTime

    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

    Definition Classes
    ChronoUnitTemporalUnit
    Exceptions thrown
    DateTimeException

    if the period cannot be added

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def between(temporal1: Temporal, temporal2: Temporal): Long

    Calculates the period in terms of this unit between two temporal objects of the same type.

    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.

    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

    Definition Classes
    ChronoUnitTemporalUnit
    Exceptions thrown
    ArithmeticException

    if numeric overflow occurs

    DateTimeException

    if the period cannot be calculated

  9. final def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    Enum → AnyRef
    Annotations
    @throws( ... )
  10. final def compareTo(arg0: ChronoUnit): Int

    Definition Classes
    Enum → Comparable
  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  12. final def equals(arg0: Any): Boolean

    Definition Classes
    Enum → AnyRef → Any
  13. final def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    Enum → AnyRef
  14. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  15. final def getDeclaringClass(): Class[ChronoUnit]

    Definition Classes
    Enum
  16. def getDuration: Duration

    Gets the estimated duration of this unit in the ISO calendar system.

    Gets the estimated duration of this unit in the ISO calendar system.

    All of the units in this class have an estimated duration. Days vary due to daylight saving time, while months have different lengths.

    returns

    the estimated duration of this unit, not null

    Definition Classes
    ChronoUnitTemporalUnit
  17. final def hashCode(): Int

    Definition Classes
    Enum → AnyRef → Any
  18. def isDateBased: Boolean

    Checks if this unit is a date unit.

    Checks if this unit is a date unit.

    returns

    true if a date unit, false if a time unit

    Definition Classes
    ChronoUnitTemporalUnit
  19. def isDurationEstimated: Boolean

    Checks if the duration of the unit is an estimate.

    Checks if the duration of the unit is an estimate.

    All time units in this class are considered to be accurate, while all date units in this class are considered to be estimated.

    This definition ignores leap seconds, but considers that Days vary due to daylight saving time and months have different lengths.

    returns

    true if the duration is estimated, false if accurate

    Definition Classes
    ChronoUnitTemporalUnit
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. def isSupportedBy(temporal: Temporal): Boolean

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

    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.

    temporal

    the temporal object to check, not null

    returns

    true if the unit is supported

    Definition Classes
    ChronoUnitTemporalUnit
  22. def isTimeBased: Boolean

    Checks if this unit is a time unit.

    Checks if this unit is a time unit.

    returns

    true if a time unit, false if a date unit

    Definition Classes
    ChronoUnitTemporalUnit
  23. final def name(): String

    Definition Classes
    Enum
  24. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  27. final def ordinal(): Int

    Definition Classes
    Enum
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  29. def toString(): String

    Outputs this unit as a String using the name.

    Outputs this unit as a String using the name.

    returns

    the name of this unit, not null

    Definition Classes
    ChronoUnitTemporalUnit → Enum → AnyRef → Any
  30. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from TemporalUnit

Inherited from Enum[ChronoUnit]

Inherited from Serializable

Inherited from Comparable[ChronoUnit]

Inherited from AnyRef

Inherited from Any

Ungrouped