com.avsystem.commons.misc.Timestamp.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commons-core_2.13 Show documentation

AVSystem commons library for Scala

There is a newer version: 2.22.0

package com.avsystem.commons.misc

import com.avsystem.commons.serialization.IsoInstant

import java.util.concurrent.TimeUnit
import scala.concurrent.duration.FiniteDuration

/**
  * Millisecond-precision, general purpose, cross compiled timestamp representation.
  *
  * @param millis milliseconds since UNIX epoch, UTC
  */
class Timestamp(val millis: Long) extends AnyVal with Comparable[Timestamp] {
  def compareTo(o: Timestamp): Int = java.lang.Long.compare(millis, o.millis)

  // I don't want to inherit them from Ordered or something because that would cause boxing
  def <(other: Timestamp): Boolean = millis < other.millis
  def <=(other: Timestamp): Boolean = millis <= other.millis
  def >(other: Timestamp): Boolean = millis > other.millis
  def >=(other: Timestamp): Boolean = millis >= other.millis

  def add(amount: Long, unit: TimeUnit): Timestamp = Timestamp(millis + unit.toMillis(amount))

  def +(duration: FiniteDuration): Timestamp = Timestamp(millis + duration.toMillis)
  def -(duration: FiniteDuration): Timestamp = Timestamp(millis - duration.toMillis)

  /**
    * Computes a [[FiniteDuration]] between this timestamp and some other timestamp later in time.
    */
  def until(end: Timestamp): FiniteDuration =
    FiniteDuration(end.millis - millis, TimeUnit.MILLISECONDS)

  /**
    * Computes a [[FiniteDuration]] between some timestamp earlier in time and this timestamp.
    */
  def since(start: Timestamp): FiniteDuration =
    start.until(this)

  /**
    * Computes a difference between two timestamps, expressed as [[FiniteDuration]]. Alias for [[since]].
    */
  def -(start: Timestamp): FiniteDuration =
    since(start)

  override def toString: String = IsoInstant.format(millis)
}
object Timestamp {
  final val Zero = Timestamp(0)

  def apply(millis: Long): Timestamp = new Timestamp(millis)
  def unapply(timestamp: Timestamp): Opt[Long] = Opt(timestamp.millis)
  def parse(str: String): Timestamp = Timestamp(IsoInstant.parse(str))

  def now(): Timestamp = Timestamp(System.currentTimeMillis())

  implicit def conversions(tstamp: Timestamp): TimestampConversions =
    new TimestampConversions(tstamp.millis)

  implicit val ordering: Ordering[Timestamp] =
    Ordering.by(_.millis)
}