object PosLong
The companion object for PosLong
that offers
factory methods that produce PosLong
s, implicit
widening conversions from PosLong
to other
numeric types, and maximum and minimum constant values for
PosLong
.
- Source
- PosLong.scala
- Alphabetic
- By Inheritance
- PosLong
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final val MaxValue: PosLong
The largest value representable as a positive
Long
, which isPosLong(9223372036854775807)
. - final val MinValue: PosLong
The smallest value representable as a positive
Long
, which isPosLong(1L)
. - implicit macro def apply(value: Long): PosLong
A factory method, implemented via a macro, that produces a
PosLong
if passed a validLong
literal, otherwise a compile time error.A factory method, implemented via a macro, that produces a
PosLong
if passed a validLong
literal, otherwise a compile time error.The macro that implements this method will inspect the specified
Long
expression at compile time. If the expression is a positiveLong
literal, it will return aPosLong
representing that value. Otherwise, the passedLong
expression is either a literal that is not positive, or is not a literal, so this method will give a compiler error.This factory method differs from the
from
factory method in that this method is implemented via a macro that inspectsLong
literals at compile time, whereasfrom
inspectsLong
values at run time.- value
the
Long
literal expression to inspect at compile time, and if positive, to return wrapped in aPosLong
at run time.- returns
the specified, valid
Long
literal value wrapped in aPosLong
. (If the specified expression is not a validLong
literal, the invocation of this method will not compile.)
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuringValid(value: Long): PosLong
A factory/assertion method that produces an
PosLong
given a validLong
value, or throwsAssertionError
, if given an invalidLong
value.A factory/assertion method that produces an
PosLong
given a validLong
value, or throwsAssertionError
, if given an invalidLong
value.Note: you should use this method only when you are convinced that it will always succeed, i.e., never throw an exception. It is good practice to add a comment near the invocation of this method indicating why you think it will always succeed to document your reasoning. If you are not sure an
ensuringValid
call will always succeed, you should use one of the other factory or validation methods provided on this object instead:isValid
,tryingValid
,passOrElse
,goodOrElse
, orrightOrElse
.This method will inspect the passed
Long
value and if it is a positiveLong
, it will return aPosLong
representing that value. Otherwise, the passedLong
value is not positive, so this method will throwAssertionError
.This factory method differs from the
apply
factory method in thatapply
is implemented via a macro that inspectsLong
literals at compile time, whereasfrom
inspectsLong
values at run time. It differs from a vanillaassert
orensuring
call in that you get something you didn't already have if the assertion succeeds: a type that promises aLong
is positive.- value
the
Long
to inspect, and if positive, return wrapped in aPosLong
.- returns
the specified
Long
value wrapped in aPosLong
, if it is positive, else throwsAssertionError
.
- Exceptions thrown
AssertionError
if the passed value is not positive
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def from(value: Long): Option[PosLong]
A factory method that produces an
Option[PosLong]
given aLong
value.A factory method that produces an
Option[PosLong]
given aLong
value.This method will inspect the passed
Long
value and if it is a positiveLong
, it will return aPosLong
representing that value, wrapped in aSome
. Otherwise, the passedLong
value is not positive, so this method will returnNone
.This factory method differs from the
apply
factory method in thatapply
is implemented via a macro that inspectsLong
literals at compile time, whereasfrom
inspectsLong
values at run time.- value
the
Long
to inspect, and if positive, return wrapped in aSome[PosLong]
.- returns
the specified
Long
value wrapped in aSome[PosLong]
, if it is positive, elseNone
.
- def fromOrElse(value: Long, default: => PosLong): PosLong
A factory method that produces a
PosLong
given aLong
value and a defaultPosLong
.A factory method that produces a
PosLong
given aLong
value and a defaultPosLong
.This method will inspect the passed
Long
value and if it is a positiveLong
, it will return aPosLong
representing that value. Otherwise, the passedLong
value is not positive, so this method will return the passeddefault
value.This factory method differs from the
apply
factory method in thatapply
is implemented via a macro that inspectsLong
literals at compile time, whereasfrom
inspectsLong
values at run time.- value
the
Long
to inspect, and if positive, return.- default
the
PosLong
to return if the passedLong
value is not positive.- returns
the specified
Long
value wrapped in aPosLong
, if it is positive, else thedefault
PosLong
value.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def goodOrElse[B](value: Long)(f: (Long) => B): Or[PosLong, B]
A factory/validation method that produces a
PosLong
, wrapped in aGood
, given a validLong
value, or if the givenLong
is invalid, an error value of typeB
produced by passing the given invalidLong
value to the given functionf
, wrapped in aBad
.A factory/validation method that produces a
PosLong
, wrapped in aGood
, given a validLong
value, or if the givenLong
is invalid, an error value of typeB
produced by passing the given invalidLong
value to the given functionf
, wrapped in aBad
.This method will inspect the passed
Long
value and if it is a positiveLong
, it will return aPosLong
representing that value, wrapped in aGood
. Otherwise, the passedLong
value is not positive, so this method will return a result of typeB
obtained by passing the invalidLong
value to the given functionf
, wrapped in aBad
.This factory method differs from the
apply
factory method in thatapply
is implemented via a macro that inspectsLong
literals at compile time, whereas this method inspectsLong
values at run time.- value
the
Long
to inspect, and if positive, return wrapped in aGood(PosLong)
.- returns
the specified
Long
value wrapped in aGood(PosLong)
, if it is positive, else aBad(f(value))
.
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isValid(value: Long): Boolean
A predicate method that returns true if a given
Long
value is positive.A predicate method that returns true if a given
Long
value is positive.- value
the
Long
to inspect, and if positive, return true.- returns
true if the specified
Long
is positive, else false.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- implicit val ordering: Ordering[PosLong]
Implicit Ordering instance.
- def passOrElse[E](value: Long)(f: (Long) => E): Validation[E]
A validation method that produces a
Pass
given a validLong
value, or an error value of typeE
produced by passing the given invalidInt
value to the given functionf
, wrapped in aFail
.A validation method that produces a
Pass
given a validLong
value, or an error value of typeE
produced by passing the given invalidInt
value to the given functionf
, wrapped in aFail
.This method will inspect the passed
Long
value and if it is a positiveLong
, it will return aPass
. Otherwise, the passedLong
value is positive, so this method will return a result of typeE
obtained by passing the invalidLong
value to the given functionf
, wrapped in aFail
.This factory method differs from the
apply
factory method in thatapply
is implemented via a macro that inspectsLong
literals at compile time, whereas this method inspectsLong
values at run time.- value
the
Long
to validate that it is positive.- returns
a
Pass
if the specifiedLong
value is positive, else aFail
containing an error value produced by passing the specifiedLong
to the given functionf
.
- def rightOrElse[L](value: Long)(f: (Long) => L): Either[L, PosLong]
A factory/validation method that produces a
PosLong
, wrapped in aRight
, given a validInt
value, or if the givenInt
is invalid, an error value of typeL
produced by passing the given invalidInt
value to the given functionf
, wrapped in aLeft
.A factory/validation method that produces a
PosLong
, wrapped in aRight
, given a validInt
value, or if the givenInt
is invalid, an error value of typeL
produced by passing the given invalidInt
value to the given functionf
, wrapped in aLeft
.This method will inspect the passed
Int
value and if it is a positiveInt
, it will return aPosLong
representing that value, wrapped in aRight
. Otherwise, the passedInt
value is not positive, so this method will return a result of typeL
obtained by passing the invalidInt
value to the given functionf
, wrapped in aLeft
.This factory method differs from the
apply
factory method in thatapply
is implemented via a macro that inspectsInt
literals at compile time, whereas this method inspectsInt
values at run time.- value
the
Int
to inspect, and if positive, return wrapped in aRight(PosLong)
.- returns
the specified
Int
value wrapped in aRight(PosLong)
, if it is positive, else aLeft(f(value))
.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def tryingValid(value: Long): Try[PosLong]
A factory/validation method that produces a
PosLong
, wrapped in aSuccess
, given a validLong
value, or if the givenLong
is invalid, anAssertionError
, wrapped in aFailure
.A factory/validation method that produces a
PosLong
, wrapped in aSuccess
, given a validLong
value, or if the givenLong
is invalid, anAssertionError
, wrapped in aFailure
.This method will inspect the passed
Long
value and if it is a positiveLong
, it will return aPosLong
representing that value, wrapped in aSuccess
. Otherwise, the passedLong
value is not positive, so this method will return anAssertionError
, wrapped in aFailure
.This factory method differs from the
apply
factory method in thatapply
is implemented via a macro that inspectsLong
literals at compile time, whereas this method inspectsLong
values at run time.- value
the
Long
to inspect, and if positive, return wrapped in aSuccess(PosLong)
.- returns
the specified
Long
value wrapped in aSuccess(PosLong)
, if it is positive, else aFailure(AssertionError)
.
- 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
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- implicit def widenToDouble(pos: PosLong): Double
Implicit widening conversion from
PosLong
toDouble
.Implicit widening conversion from
PosLong
toDouble
.- pos
the
PosLong
to widen- returns
the
Long
value underlying the specifiedPosLong
, widened toDouble
.
- implicit def widenToFloat(pos: PosLong): Float
Implicit widening conversion from
PosLong
toFloat
.Implicit widening conversion from
PosLong
toFloat
.- pos
the
PosLong
to widen- returns
the
Long
value underlying the specifiedPosLong
, widened toFloat
.
- implicit def widenToLong(pos: PosLong): Long
Implicit widening conversion from
PosLong
toLong
.Implicit widening conversion from
PosLong
toLong
.- pos
the
PosLong
to widen- returns
the
Long
value underlying the specifiedPosLong
.
- implicit def widenToNonZeroDouble(pos: PosLong): NonZeroDouble
Implicit widening conversion from
PosLong
toNonZeroDouble
.Implicit widening conversion from
PosLong
toNonZeroDouble
.- pos
the
PosLong
to widen- returns
the
Long
value underlying the specifiedPosLong
, widened toDouble
and wrapped in aNonZeroDouble
.
- implicit def widenToNonZeroFloat(pos: PosLong): NonZeroFloat
Implicit widening conversion from
PosLong
toNonZeroFloat
.Implicit widening conversion from
PosLong
toNonZeroFloat
.- pos
the
PosLong
to widen- returns
the
Long
value underlying the specifiedPosLong
, widened toFloat
and wrapped in aNonZeroFloat
.
- implicit def widenToNonZeroLong(pos: PosLong): NonZeroLong
Implicit widening conversion from
PosLong
toNonZeroLong
.Implicit widening conversion from
PosLong
toNonZeroLong
.- pos
the
PosLong
to widen- returns
the
Long
value underlying the specifiedPosLong
, widened toLong
and wrapped in aNonZeroLong
.
- implicit def widenToPosDouble(pos: PosLong): PosDouble
Implicit widening conversion from
PosLong
toPosDouble
.Implicit widening conversion from
PosLong
toPosDouble
.- pos
the
PosLong
to widen- returns
the
Long
value underlying the specifiedPosLong
, widened toDouble
and wrapped in aPosDouble
.
- implicit def widenToPosFloat(pos: PosLong): PosFloat
Implicit widening conversion from
PosLong
toPosFloat
.Implicit widening conversion from
PosLong
toPosFloat
.- pos
the
PosLong
to widen- returns
the
Long
value underlying the specifiedPosLong
, widened toFloat
and wrapped in aPosFloat
.
- implicit def widenToPosZDouble(pos: PosLong): PosZDouble
Implicit widening conversion from
PosLong
toPosZDouble
.Implicit widening conversion from
PosLong
toPosZDouble
.- pos
the
PosLong
to widen- returns
the
Long
value underlying the specifiedPosLong
, widened toDouble
and wrapped in aPosZDouble
.
- implicit def widenToPosZFloat(pos: PosLong): PosZFloat
Implicit widening conversion from
PosLong
toPosZFloat
.Implicit widening conversion from
PosLong
toPosZFloat
.- pos
the
PosLong
to widen- returns
the
Long
value underlying the specifiedPosLong
, widened toFloat
and wrapped in aPosZFloat
.
- implicit def widenToPosZLong(pos: PosLong): PosZLong
Implicit widening conversion from
PosLong
toPosZLong
.Implicit widening conversion from
PosLong
toPosZLong
.- pos
the
PosLong
to widen- returns
the
Long
value underlying the specifiedPosLong
, widened toLong
and wrapped in aPosZLong
.
Deprecated Value Members
- val posLongOrd: Ordering[PosLong]
The formerly implicit
posLongOrd
field has been deprecated and will be removed in a future version of ScalaTest. Please use theordering
field instead.The formerly implicit
posLongOrd
field has been deprecated and will be removed in a future version of ScalaTest. Please use theordering
field instead.- Annotations
- @deprecated
- Deprecated
The formerly implicit posLongOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.