object Duration extends java.io.Serializable
- Source
- Duration.scala
- Alphabetic
- By Inheritance
- Duration
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
- final def !=(arg0: Any): Boolean
Test two objects for inequality.
Test two objects for inequality.
- returns
true
if !(this == that), false otherwise.
- Definition Classes
- AnyRef → Any
- final def ##(): Int
Equivalent to
x.hashCode
except for boxed numeric types andnull
.Equivalent to
x.hashCode
except for boxed numeric types andnull
. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. Fornull
returns a hashcode wherenull.hashCode
throws aNullPointerException
.- returns
a hash value consistent with ==
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.- returns
true
if the receiver object is equivalent to the argument;false
otherwise.
- Definition Classes
- AnyRef → Any
- val Inf: Infinite
Infinite duration: greater than any other (apart from Undefined) and not equal to any other but itself.
Infinite duration: greater than any other (apart from Undefined) and not equal to any other but itself. This value closely corresponds to Double.PositiveInfinity, matching its semantics in arithmetic operations.
- val MinusInf: Infinite
Infinite duration: less than any other and not equal to any other but itself.
Infinite duration: less than any other and not equal to any other but itself. This value closely corresponds to Double.NegativeInfinity, matching its semantics in arithmetic operations.
- val Undefined: Infinite
The Undefined value corresponds closely to Double.NaN:
The Undefined value corresponds closely to Double.NaN:
- it is the result of otherwise invalid operations
- it does not equal itself (according to
equals()
) - it compares greater than any other Duration apart from itself (for which
compare
returns 0)
The particular comparison semantics mirror those of Double.NaN.
Use eq when checking an input of a method against this value.
- val Zero: FiniteDuration
Preconstructed value of
0.days
. - def apply(s: String): Duration
Parse String into Duration.
Parse String into Duration. Format is
"<length><unit>"
, where whitespace is allowed before, between and after the parts. Infinities are designated by"Inf"
,"PlusInf"
,"+Inf"
,"Duration.Inf"
and"-Inf"
,"MinusInf"
or"Duration.MinusInf"
. Undefined is designated by"Duration.Undefined"
.- Exceptions thrown
NumberFormatException
if format is not parsable
- def apply(length: Long, unit: String): FiniteDuration
Construct a finite duration from the given length and time unit, where the latter is looked up in a list of string representation.
Construct a finite duration from the given length and time unit, where the latter is looked up in a list of string representation. Valid choices are:
d, day, h, hour, min, minute, s, sec, second, ms, milli, millisecond, µs, micro, microsecond, ns, nano, nanosecond
and their pluralized forms (for every but the first mentioned form of each unit, i.e. no "ds", but "days"). - def apply(length: Long, unit: TimeUnit): FiniteDuration
Construct a finite duration from the given length and time unit.
Construct a finite duration from the given length and time unit. The unit given is retained throughout calculations as long as possible, so that it can be retrieved later.
- def apply(length: Double, unit: TimeUnit): Duration
Construct a Duration from the given length and unit.
Construct a Duration from the given length and unit. Observe that nanosecond precision may be lost if
- the unit is NANOSECONDS
- and the length has an absolute value greater than
2^53
Infinite inputs (and NaN) are converted into Duration.Inf, Duration.MinusInf and Duration.Undefined, respectively.
- Exceptions thrown
IllegalArgumentException
if the length was finite but the resulting duration cannot be expressed as a FiniteDuration
- final def asInstanceOf[T0]: T0
Cast the receiver object to be of type
T0
.Cast the receiver object to be of type
T0
.Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression
1.asInstanceOf[String]
will throw aClassCastException
at runtime, while the expressionList(1).asInstanceOf[List[String]]
will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.- returns
the receiver object.
- Definition Classes
- Any
- Exceptions thrown
ClassCastException
if the receiver object is not an instance of the erasure of typeT0
.
- def clone(): AnyRef
Create a copy of the receiver object.
Create a copy of the receiver object.
The default implementation of the
clone
method is platform dependent.- returns
a copy of the receiver object.
- def create(s: String): Duration
Parse String into Duration.
Parse String into Duration. Format is
"<length><unit>"
, where whitespace is allowed before, between and after the parts. Infinities are designated by"Inf"
,"PlusInf"
,"+Inf"
and"-Inf"
or"MinusInf"
.- Exceptions thrown
NumberFormatException
if format is not parsable
- def create(length: Long, unit: String): FiniteDuration
Construct a finite duration from the given length and time unit, where the latter is looked up in a list of string representation.
Construct a finite duration from the given length and time unit, where the latter is looked up in a list of string representation. Valid choices are:
d, day, h, hour, min, minute, s, sec, second, ms, milli, millisecond, µs, micro, microsecond, ns, nano, nanosecond
and their pluralized forms (for every but the first mentioned form of each unit, i.e. no "ds", but "days"). - def create(length: Double, unit: TimeUnit): Duration
Construct a Duration from the given length and unit.
Construct a Duration from the given length and unit. Observe that nanosecond precision may be lost if
- the unit is NANOSECONDS
- and the length has an absolute value greater than
2^53
Infinite inputs (and NaN) are converted into Duration.Inf, Duration.MinusInf and Duration.Undefined, respectively.
- Exceptions thrown
IllegalArgumentException
if the length was finite but the resulting duration cannot be expressed as a FiniteDuration
- def create(length: Long, unit: TimeUnit): FiniteDuration
Construct a finite duration from the given length and time unit.
Construct a finite duration from the given length and time unit. The unit given is retained throughout calculations as long as possible, so that it can be retrieved later.
- final def eq(arg0: AnyRef): Boolean
Tests whether the argument (
that
) is a reference to the receiver object (this
).Tests whether the argument (
that
) is a reference to the receiver object (this
).The
eq
method implements an equivalence relation on non-null instances ofAnyRef
, and has three additional properties:- It is consistent: for any non-null instances
x
andy
of typeAnyRef
, multiple invocations ofx.eq(y)
consistently returnstrue
or consistently returnsfalse
. - For any non-null instance
x
of typeAnyRef
,x.eq(null)
andnull.eq(x)
returnsfalse
. null.eq(null)
returnstrue
.
When overriding the
equals
orhashCode
methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2
), they should be equal to each other (o1 == o2
) and they should hash to the same value (o1.hashCode == o2.hashCode
).- returns
true
if the argument is a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
- It is consistent: for any non-null instances
- def equals(arg0: AnyRef): Boolean
The equality method for reference types.
- def finalize(): Unit
Called by the garbage collector on the receiver object when there are no more references to the object.
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the
finalize
method is invoked, as well as the interaction betweenfinalize
and non-local returns and exceptions, are all platform dependent. - def fromNanos(nanos: Long): FiniteDuration
Construct a finite duration from the given number of nanoseconds.
Construct a finite duration from the given number of nanoseconds. The result will have the coarsest possible time unit which can exactly express this duration.
- Exceptions thrown
IllegalArgumentException
forLong.MinValue
since that would lead to inconsistent behavior afterwards (cannot be negated)
- def fromNanos(nanos: Double): Duration
Construct a possibly infinite or undefined Duration from the given number of nanoseconds.
Construct a possibly infinite or undefined Duration from the given number of nanoseconds.
Double.PositiveInfinity
is mapped to Duration.InfDouble.NegativeInfinity
is mapped to Duration.MinusInfDouble.NaN
is mapped to Duration.Undefined-0d
is mapped to Duration.Zero (exactly like0d
)
The semantics of the resulting Duration objects matches the semantics of their Double counterparts with respect to arithmetic operations.
- Exceptions thrown
IllegalArgumentException
if the length was finite but the resulting duration cannot be expressed as a FiniteDuration
- final def getClass(): Class[_ <: AnyRef]
Returns the runtime class representation of the object.
- def hashCode(): Int
The hashCode method for reference types.
- final def isInstanceOf[T0]: Boolean
Test whether the dynamic type of the receiver object is
T0
.Test whether the dynamic type of the receiver object is
T0
.Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression
1.isInstanceOf[String]
will returnfalse
, while the expressionList(1).isInstanceOf[List[String]]
will returntrue
. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.- returns
true
if the receiver object is an instance of erasure of typeT0
;false
otherwise.
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
Equivalent to
!(this eq that)
.Equivalent to
!(this eq that)
.- returns
true
if the argument is not a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
- final def notify(): Unit
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
- final def notifyAll(): Unit
Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeUnit: Map[String, TimeUnit]
- Attributes
- protected[scala.concurrent.duration]
- val timeUnitName: Map[TimeUnit, String]
- Attributes
- protected[scala.concurrent.duration]
- def toString(): String
Creates a String representation of this object.
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
- returns
a String representation of the object.
- Definition Classes
- AnyRef → Any
- def unapply(d: Duration): Option[(Long, TimeUnit)]
Extract length and time unit out of a duration, if it is finite.
- def unapply(s: String): Option[(Long, TimeUnit)]
Extract length and time unit out of a string, where the format must match the description for apply(String).
Extract length and time unit out of a string, where the format must match the description for apply(String). The extractor will not match for malformed strings or non-finite durations.
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- implicit object DurationIsOrdered extends Ordering[Duration]
The natural ordering of durations matches the natural ordering for Double, including non-finite values.
This is the documentation for the Scala standard library.
Package structure
The scala package contains core types like
Int
,Float
,Array
orOption
which are accessible in all Scala compilation units without explicit qualification or imports.Notable packages include:
scala.collection
and its sub-packages contain Scala's collections frameworkscala.collection.immutable
- Immutable, sequential data-structures such asVector
,List
,Range
,HashMap
orHashSet
scala.collection.mutable
- Mutable, sequential data-structures such asArrayBuffer
,StringBuilder
,HashMap
orHashSet
scala.collection.concurrent
- Mutable, concurrent data-structures such asTrieMap
scala.concurrent
- Primitives for concurrent programming such asFutures
andPromises
scala.io
- Input and output operationsscala.math
- Basic math functions and additional numeric types likeBigInt
andBigDecimal
scala.sys
- Interaction with other processes and the operating systemscala.util.matching
- Regular expressionsOther packages exist. See the complete list on the right.
Additional parts of the standard library are shipped as separate libraries. These include:
scala.reflect
- Scala's reflection API (scala-reflect.jar)scala.xml
- XML parsing, manipulation, and serialization (scala-xml.jar)scala.collection.parallel
- Parallel collections (scala-parallel-collections.jar)scala.util.parsing
- Parser combinators (scala-parser-combinators.jar)scala.swing
- A convenient wrapper around Java's GUI framework called Swing (scala-swing.jar)Automatic imports
Identifiers in the scala package and the
scala.Predef
object are always in scope by default.Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example,
List
is an alias forscala.collection.immutable.List
.Other aliases refer to classes provided by the underlying platform. For example, on the JVM,
String
is an alias forjava.lang.String
.