com.datastax.oss.driver.api.core.data

Class CqlDuration

java.lang.Object

com.datastax.oss.driver.api.core.data.CqlDuration

All Implemented Interfaces:

TemporalAmount

@Immutable
public final class CqlDuration
extends Object
implements TemporalAmount

A duration, as defined in CQL.

It stores months, days, and seconds separately due to the fact that the number of days in a month varies, and a day can have 23 or 25 hours if a daylight saving is involved. As such, this type differs from Duration (which only represents an amount between two points in time, regardless of the calendar).

Method Summary

Modifier and Type	Method and Description
Temporal	addTo(Temporal temporal)
boolean	equals(Object other)
static CqlDuration	from(String input) Converts a String into a duration.
long	get(TemporalUnit unit)
int	getDays() Returns the number of days in this duration.
int	getMonths() Returns the number of months in this duration.
long	getNanoseconds() Returns the number of nanoseconds in this duration.
List<TemporalUnit>	getUnits()
int	hashCode()
static CqlDuration	newInstance(int months, int days, long nanoseconds) Creates a duration with the given number of months, days and nanoseconds.
Temporal	subtractFrom(Temporal temporal)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

newInstance

public static CqlDuration newInstance(int months,
                                      int days,
                                      long nanoseconds)

Creates a duration with the given number of months, days and nanoseconds.

A duration can be negative. In this case, all the non zero values must be negative.

Parameters:

months - the number of months

days - the number of days

nanoseconds - the number of nanoseconds

Throws:

IllegalArgumentException - if the values are not all negative or all positive

from

public static CqlDuration from(@NonNull
                               String input)

Converts a String into a duration.

The accepted formats are:

• multiple digits followed by a time unit like: 12h30m where the time unit can be:
  • y: years
  • mo: months
  • w: weeks
  • d: days
  • h: hours
  • m: minutes
  • s: seconds
  • ms: milliseconds
  • us or µs: microseconds
  • ns: nanoseconds
• ISO 8601 format: P[n]Y[n]M[n]DT[n]H[n]M[n]S or P[n]W
• ISO 8601 alternative format: P[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]

Parameters:

input - the String to convert

getMonths

public int getMonths()

Returns the number of months in this duration.

Returns:

the number of months in this duration.

getDays

public int getDays()

Returns the number of days in this duration.

Returns:

the number of days in this duration.

getNanoseconds

public long getNanoseconds()

Returns the number of nanoseconds in this duration.

Returns:

the number of months in this duration.

addTo

public Temporal addTo(Temporal temporal)

This implementation converts the months and days components to a Period, and the nanosecond component to a Duration, and adds those two amounts to the temporal object. Therefore the chronology of the temporal must be either the ISO chronology or null.

Specified by:

addTo in interface TemporalAmount

See Also:

Period.addTo(Temporal), Duration.addTo(Temporal)

subtractFrom

public Temporal subtractFrom(Temporal temporal)

This implementation converts the months and days components to a Period, and the nanosecond component to a Duration, and subtracts those two amounts to the temporal object. Therefore the chronology of the temporal must be either the ISO chronology or null.

Specified by:

subtractFrom in interface TemporalAmount

See Also:

Period.subtractFrom(Temporal), Duration.subtractFrom(Temporal)

get

public long get(TemporalUnit unit)

Specified by:

get in interface TemporalAmount

getUnits

public List<TemporalUnit> getUnits()

Specified by:

getUnits in interface TemporalAmount

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object