Liking cljdoc? Tell your friends :D

jdk.time.temporal.ChronoUnit


*value-ofclj

(*value-of 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.)

name - the name of the enum constant to be returned. - java.lang.String

returns: the enum constant with the specified name - java.time.temporal.ChronoUnit

throws: java.lang.IllegalArgumentException - if this enum type has no constant with the specified 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.)

name - the name of the enum constant to be returned. - `java.lang.String`

returns: the enum constant with the specified name - `java.time.temporal.ChronoUnit`

throws: java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
raw docstring

*valuesclj

(*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 (ChronoUnit c : ChronoUnit.values()) System.out.println(c);

returns: an array containing the constants of this enum type, in the order they are declared - java.time.temporal.ChronoUnit[]

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 (ChronoUnit c : ChronoUnit.values())
    System.out.println(c);

returns: an array containing the constants of this enum type, in the order they are declared - `java.time.temporal.ChronoUnit[]`
raw docstring

add-toclj

(add-to this temporal amount)

Description copied from interface: TemporalUnit

temporal - the temporal object to adjust, not null - R amount - the amount of this unit to add, positive or negative - long

returns: the adjusted temporal object, not null - <R extends java.time.temporal.Temporal> R

Description copied from interface: TemporalUnit

temporal - the temporal object to adjust, not null - `R`
amount - the amount of this unit to add, positive or negative - `long`

returns: the adjusted temporal object, not null - `<R extends java.time.temporal.Temporal> R`
raw docstring

betweenclj

(between this temporal-1-inclusive temporal-2-exclusive)

Description copied from interface: TemporalUnit

temporal-1-inclusive - the base temporal object, not null - java.time.temporal.Temporal temporal-2-exclusive - the other temporal object, exclusive, not null - java.time.temporal.Temporal

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

Description copied from interface: TemporalUnit

temporal-1-inclusive - the base temporal object, not null - `java.time.temporal.Temporal`
temporal-2-exclusive - the other temporal object, exclusive, not null - `java.time.temporal.Temporal`

returns: the amount of time between temporal1Inclusive and temporal2Exclusive
  in terms of this unit; positive if temporal2Exclusive is later than
  temporal1Inclusive, negative if earlier - `long`
raw docstring

CENTURIESclj

Enum Constant.

Unit that represents the concept of a century. For the ISO calendar system, it is equal to 100 years.

When used with other calendar systems it must correspond to an integral number of days and is normally an integral number of years.

type: java.time.temporal.ChronoUnit

Enum Constant.

Unit that represents the concept of a century.
 For the ISO calendar system, it is equal to 100 years.

 When used with other calendar systems it must correspond to an integral number of days
 and is normally an integral number of years.

type: java.time.temporal.ChronoUnit
raw docstring

date-based?clj

(date-based? this)

Checks if this unit is a date unit.

All units from days to eras inclusive are date-based. Time-based units and FOREVER return false.

returns: true if a date unit, false if a time unit - boolean

Checks if this unit is a date unit.

 All units from days to eras inclusive are date-based.
 Time-based units and FOREVER return false.

returns: true if a date unit, false if a time unit - `boolean`
raw docstring

DAYSclj

Enum Constant.

Unit that represents the concept of a day. For the ISO calendar system, it is the standard day from midnight to midnight. The estimated duration of a day is 24 Hours.

When used with other calendar systems it must correspond to the day defined by the rising and setting of the Sun on Earth. It is not required that days begin at midnight - when converting between calendar systems, the date should be equivalent at midday.

type: java.time.temporal.ChronoUnit

Enum Constant.

Unit that represents the concept of a day.
 For the ISO calendar system, it is the standard day from midnight to midnight.
 The estimated duration of a day is 24 Hours.

 When used with other calendar systems it must correspond to the day defined by
 the rising and setting of the Sun on Earth. It is not required that days begin
 at midnight - when converting between calendar systems, the date should be
 equivalent at midday.

type: java.time.temporal.ChronoUnit
raw docstring

DECADESclj

Enum Constant.

Unit that represents the concept of a decade. For the ISO calendar system, it is equal to 10 years.

When used with other calendar systems it must correspond to an integral number of days and is normally an integral number of years.

type: java.time.temporal.ChronoUnit

Enum Constant.

Unit that represents the concept of a decade.
 For the ISO calendar system, it is equal to 10 years.

 When used with other calendar systems it must correspond to an integral number of days
 and is normally an integral number of years.

type: java.time.temporal.ChronoUnit
raw docstring

duration-estimated?clj

(duration-estimated? this)

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 - boolean

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 - `boolean`
raw docstring

ERASclj

Enum Constant.

Unit that represents the concept of an era. The ISO calendar system doesn't have eras thus it is impossible to add an era to a date or date-time. The estimated duration of the era is artificially defined as 1,000,000,000 Years.

When used with other calendar systems there are no restrictions on the unit.

type: java.time.temporal.ChronoUnit

Enum Constant.

Unit that represents the concept of an era.
 The ISO calendar system doesn't have eras thus it is impossible to add
 an era to a date or date-time.
 The estimated duration of the era is artificially defined as 1,000,000,000 Years.

 When used with other calendar systems there are no restrictions on the unit.

type: java.time.temporal.ChronoUnit
raw docstring

FOREVERclj

Enum Constant.

Artificial unit that represents the concept of forever. This is primarily used with TemporalField to represent unbounded fields such as the year or era. The estimated duration of the era is artificially defined as the largest duration supported by Duration.

type: java.time.temporal.ChronoUnit

Enum Constant.

Artificial unit that represents the concept of forever.
 This is primarily used with TemporalField to represent unbounded fields
 such as the year or era.
 The estimated duration of the era is artificially defined as the largest duration
 supported by Duration.

type: java.time.temporal.ChronoUnit
raw docstring

get-durationclj

(get-duration this)

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 - java.time.Duration

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 - `java.time.Duration`
raw docstring

HALF_DAYSclj

Enum Constant.

Unit that represents the concept of half a day, as used in AM/PM. For the ISO calendar system, it is equal to 12 hours.

type: java.time.temporal.ChronoUnit

Enum Constant.

Unit that represents the concept of half a day, as used in AM/PM.
 For the ISO calendar system, it is equal to 12 hours.

type: java.time.temporal.ChronoUnit
raw docstring

HOURSclj

Enum Constant.

Unit that represents the concept of an hour. For the ISO calendar system, it is equal to 60 minutes.

type: java.time.temporal.ChronoUnit

Enum Constant.

Unit that represents the concept of an hour.
 For the ISO calendar system, it is equal to 60 minutes.

type: java.time.temporal.ChronoUnit
raw docstring

MICROSclj

Enum Constant.

Unit that represents the concept of a microsecond. For the ISO calendar system, it is equal to the 1,000,000th part of the second unit.

type: java.time.temporal.ChronoUnit

Enum Constant.

Unit that represents the concept of a microsecond.
 For the ISO calendar system, it is equal to the 1,000,000th part of the second unit.

type: java.time.temporal.ChronoUnit
raw docstring

MILLENNIAclj

Enum Constant.

Unit that represents the concept of a millennium. For the ISO calendar system, it is equal to 1000 years.

When used with other calendar systems it must correspond to an integral number of days and is normally an integral number of years.

type: java.time.temporal.ChronoUnit

Enum Constant.

Unit that represents the concept of a millennium.
 For the ISO calendar system, it is equal to 1000 years.

 When used with other calendar systems it must correspond to an integral number of days
 and is normally an integral number of years.

type: java.time.temporal.ChronoUnit
raw docstring

MILLISclj

Enum Constant.

Unit that represents the concept of a millisecond. For the ISO calendar system, it is equal to the 1000th part of the second unit.

type: java.time.temporal.ChronoUnit

Enum Constant.

Unit that represents the concept of a millisecond.
 For the ISO calendar system, it is equal to the 1000th part of the second unit.

type: java.time.temporal.ChronoUnit
raw docstring

MINUTESclj

Enum Constant.

Unit that represents the concept of a minute. For the ISO calendar system, it is equal to 60 seconds.

type: java.time.temporal.ChronoUnit

Enum Constant.

Unit that represents the concept of a minute.
 For the ISO calendar system, it is equal to 60 seconds.

type: java.time.temporal.ChronoUnit
raw docstring

MONTHSclj

Enum Constant.

Unit that represents the concept of a month. For the ISO calendar system, the length of the month varies by month-of-year. The estimated duration of a month is one twelfth of 365.2425 Days.

When used with other calendar systems it must correspond to an integral number of days.

type: java.time.temporal.ChronoUnit

Enum Constant.

Unit that represents the concept of a month.
 For the ISO calendar system, the length of the month varies by month-of-year.
 The estimated duration of a month is one twelfth of 365.2425 Days.

 When used with other calendar systems it must correspond to an integral number of days.

type: java.time.temporal.ChronoUnit
raw docstring

NANOSclj

Enum Constant.

Unit that represents the concept of a nanosecond, the smallest supported unit of time. For the ISO calendar system, it is equal to the 1,000,000,000th part of the second unit.

type: java.time.temporal.ChronoUnit

Enum Constant.

Unit that represents the concept of a nanosecond, the smallest supported unit of time.
 For the ISO calendar system, it is equal to the 1,000,000,000th part of the second unit.

type: java.time.temporal.ChronoUnit
raw docstring

SECONDSclj

Enum Constant.

Unit that represents the concept of a second. For the ISO calendar system, it is equal to the second in the SI system of units, except around a leap-second.

type: java.time.temporal.ChronoUnit

Enum Constant.

Unit that represents the concept of a second.
 For the ISO calendar system, it is equal to the second in the SI system
 of units, except around a leap-second.

type: java.time.temporal.ChronoUnit
raw docstring

supported-by?clj

(supported-by? this temporal)

Description copied from interface: TemporalUnit

temporal - the temporal object to check, not null - java.time.temporal.Temporal

returns: true if the unit is supported - boolean

Description copied from interface: TemporalUnit

temporal - the temporal object to check, not null - `java.time.temporal.Temporal`

returns: true if the unit is supported - `boolean`
raw docstring

time-based?clj

(time-based? this)

Checks if this unit is a time unit.

All units from nanos to half-days inclusive are time-based. Date-based units and FOREVER return false.

returns: true if a time unit, false if a date unit - boolean

Checks if this unit is a time unit.

 All units from nanos to half-days inclusive are time-based.
 Date-based units and FOREVER return false.

returns: true if a time unit, false if a date unit - `boolean`
raw docstring

to-stringclj

(to-string this)

Description copied from class: Enum

returns: the name of this enum constant - java.lang.String

Description copied from class: Enum

returns: the name of this enum constant - `java.lang.String`
raw docstring

WEEKSclj

Enum Constant.

Unit that represents the concept of a week. For the ISO calendar system, it is equal to 7 days.

When used with other calendar systems it must correspond to an integral number of days.

type: java.time.temporal.ChronoUnit

Enum Constant.

Unit that represents the concept of a week.
 For the ISO calendar system, it is equal to 7 days.

 When used with other calendar systems it must correspond to an integral number of days.

type: java.time.temporal.ChronoUnit
raw docstring

YEARSclj

Enum Constant.

Unit that represents the concept of a year. For the ISO calendar system, it is equal to 12 months. The estimated duration of a year is 365.2425 Days.

When used with other calendar systems it must correspond to an integral number of days or months roughly equal to a year defined by the passage of the Earth around the Sun.

type: java.time.temporal.ChronoUnit

Enum Constant.

Unit that represents the concept of a year.
 For the ISO calendar system, it is equal to 12 months.
 The estimated duration of a year is 365.2425 Days.

 When used with other calendar systems it must correspond to an integral number of days
 or months roughly equal to a year defined by the passage of the Earth around the Sun.

type: java.time.temporal.ChronoUnit
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close