scalafx.util.Duration.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scalafx_2.12.0-M5 Show documentation
The ScalaFX framework
The newest version!
/*
 * Copyright (c) 2011-2014, ScalaFX Project
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the ScalaFX Project nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE SCALAFX PROJECT OR ITS CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package scalafx.util

import javafx.{util => jfxu}

import scala.language.implicitConversions
import scalafx.delegate.SFXDelegate

/**
 * Companion Object for [[scalafx.util.Duration]].
 */
object Duration {
  implicit def sfxDuration2jfx(d: Duration): jfxu.Duration = if (d != null) d.delegate else null

  def apply(millis: Double) = new Duration(millis)

  private[util] class DurationHelper(d: Double) {
    def ms = apply(d)
    def s = new Duration(jfxu.Duration.seconds(d))
    def m = new Duration(jfxu.Duration.minutes(d))
    def h = new Duration(jfxu.Duration.hours(d))
  }

  def Indefinite = new Duration(jfxu.Duration.INDEFINITE)
  @deprecated ("Use Indefinite; INDEFINITE will be removed in a future release", "8.0.60-R10")
  def INDEFINITE = Indefinite

  def One = new Duration(jfxu.Duration.ONE)
  @deprecated ("Use One; ONE will be removed in a future release", "8.0.60-R10")
  def ONE = One

  def Unknown = new Duration(jfxu.Duration.UNKNOWN)
  @deprecated ("Use Unknown; UNKNOWN will be removed in a future release", "8.0.60-R10")
  def UNKNOWN = Unknown

  def Zero = new Duration(jfxu.Duration.ZERO)
  @deprecated ("Use Zero; ZERO will be removed in a future release", "8.0.60-R10")
  def ZERO = Zero
}

/**
 * Wraps a JavaFX [[http://docs.oracle.com/javase/8/javafx/api/javafx/util/Duration.html $D]].
 *
 * @constructor Creates a new $D from a JavaFX $D.
 * @param delegate JavaFX $D to be delegated.
 *
 * @define D `Duration`
 */
class Duration(override val delegate: jfxu.Duration) extends SFXDelegate[jfxu.Duration] with Ordered[Duration] {

  /**
   * The constructor of $D
   *
   * @param millis The length of the $D in milliseconds
   */
  def this(millis: Double) =
    this(jfxu.Duration.millis(millis))

  def +(d: jfxu.Duration) = new Duration(delegate.add(d))
  def -(d: jfxu.Duration) = new Duration(delegate.subtract(d))

  def *(d: Double) = new Duration(delegate.multiply(d))
  // Note: We are intentionally *not* supporting this...  there is no use case for multiplication with disregard to units
  // def *(d: jfxu.Duration) = delegate.multiply(d)

  def /(d: Double) = new Duration(delegate.divide(d))
  // Note: This is a "fixed" function...  rather than returning a duration we properly cancel units and return a Double
  def /(d: jfxu.Duration) = delegate.toMillis / d.toMillis

  override def compare(that: Duration) = delegate.compareTo(that)
  def <(d: jfxu.Duration) = delegate.lessThan(d)
  def <=(d: jfxu.Duration) = delegate.lessThanOrEqualTo(d)
  def >(d: jfxu.Duration) = delegate.greaterThan(d)
  def >=(d: jfxu.Duration) = delegate.greaterThanOrEqualTo(d)

  def ==(d: jfxu.Duration) = delegate.equals(d)
  def !=(d: jfxu.Duration) = !delegate.equals(d)
  def ===(d: jfxu.Duration) = delegate.equals(d)
  def =!=(d: jfxu.Duration) = !delegate.equals(d)

  def unary_-() = new Duration(delegate.negate())

}