PosInt

Companion class PosInt

object PosInt

The companion object for PosInt that offers factory methods that produce PosInts, implicit widening conversions from PosInt to other numeric types, and maximum and minimum constant values for PosInt.

Source: PosInt.scala

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

PosInt
AnyRef
Any

Hide All
Show All

Visibility

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: PosInt
The largest value representable as a positive Int, which is PosInt(2147483647).
final val MinValue: PosInt
The smallest value representable as a positive Int, which is PosInt(1).
implicit macro def apply(value: Int): PosInt
A factory method, implemented via a macro, that produces a PosInt if passed a valid Int literal, otherwise a compile time error.
A factory method, implemented via a macro, that produces a PosInt if passed a valid Int literal, otherwise a compile time error.
The macro that implements this method will inspect the specified Int expression at compile time. If the expression is a positive Int literal, i.e., with a value greater than 0, it will return a PosInt representing that value. Otherwise, the passed Int expression is either a literal that is 0 or negative, 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 inspects Int literals at compile time, whereas from inspects Int values at run time.
value
the Int literal expression to inspect at compile time, and if positive, to return wrapped in a PosInt at run time.
returns
the specified, valid Int literal value wrapped in a PosInt. (If the specified expression is not a valid Int 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: Int): PosInt
A factory/assertion method that produces a PosInt given a valid Int value, or throws AssertionError, if given an invalid Int value.
A factory/assertion method that produces a PosInt given a valid Int value, or throws AssertionError, if given an invalid Int 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, or rightOrElse.
This method will inspect the passed Int value and if it is a positive Int, it will return a PosInt representing that value. Otherwise, the passed Int value is not positive, so this method will throw AssertionError.
This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Int literals at compile time, whereas this method inspects Int values at run time. It differs from a vanilla assert or ensuring call in that you get something you didn't already have if the assertion succeeds: a type that promises an Int is positive.
value
the Int to inspect, and if positive, return wrapped in a PosInt.
returns
the specified Int value wrapped in a PosInt, if it is positive, else throws AssertionError.
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: Int): Option[PosInt]
A factory method that produces an Option[PosInt] given an Int value.
A factory method that produces an Option[PosInt] given an Int value.
This method will inspect the passed Int value and if it is a positive Int, i.e., a positive integer value, it will return a PosInt representing that value, wrapped in a Some. Otherwise, the passed Int value is not positive integer value, so this method will return None.
This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Int literals at compile time, whereas from inspects Int values at run time.
value
the Int to inspect, and if positive, return wrapped in a Some[PosInt].
returns
the specified Int value wrapped in a Some[PosInt], if it is positive, else None.
def fromOrElse(value: Int, default: => PosInt): PosInt
A factory method that produces a PosInt given a Int value and a default PosInt.
A factory method that produces a PosInt given a Int value and a default PosInt.
This method will inspect the passed Int value and if it is a positive Int, i.e., a value greater than 0.0, it will return a PosInt representing that value. Otherwise, the passed Int value is 0 or negative, so this method will return the passed default value.
This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Int literals at compile time, whereas from inspects Int values at run time.
value
the Int to inspect, and if positive, return.
default
the PosInt to return if the passed Int value is not positive.
returns
the specified Int value wrapped in a PosInt, if it is positive, else the default PosInt value.
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def goodOrElse[B](value: Int)(f: (Int) => B): Or[PosInt, B]
A factory/validation method that produces a PosInt, wrapped in a Good, given a valid Int value, or if the given Int is invalid, an error value of type B produced by passing the given invalid Int value to the given function f, wrapped in a Bad.
A factory/validation method that produces a PosInt, wrapped in a Good, given a valid Int value, or if the given Int is invalid, an error value of type B produced by passing the given invalid Int value to the given function f, wrapped in a Bad.
This method will inspect the passed Int value and if it is a positive Int, it will return a PosInt representing that value, wrapped in a Good. Otherwise, the passed Int value is not positive, so this method will return a result of type B obtained by passing the invalid Int value to the given function f, wrapped in a Bad.
This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Int literals at compile time, whereas this method inspects Int values at run time.
value
the Int to inspect, and if positive, return wrapped in a Good(PosInt).
returns
the specified Int value wrapped in a Good(PosInt), if it is positive, else a Bad(f(value)).
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
def isValid(value: Int): Boolean
A predicate method that returns true if a given Int value is positive.
A predicate method that returns true if a given Int value is positive.
value
the Int to inspect, and if positive, return true.
returns
true if the specified Int 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[PosInt]
Implicit Ordering instance.
def passOrElse[E](value: Int)(f: (Int) => E): Validation[E]
A validation method that produces a Pass given a valid Int value, or an error value of type E produced by passing the given invalid Int value to the given function f, wrapped in a Fail.
A validation method that produces a Pass given a valid Int value, or an error value of type E produced by passing the given invalid Int value to the given function f, wrapped in a Fail.
This method will inspect the passed Int value and if it is a positive Int, it will return a Pass. Otherwise, the passed Int value is positive, so this method will return a result of type E obtained by passing the invalid Int value to the given function f, wrapped in a Fail.
This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Int literals at compile time, whereas this method inspects Int values at run time.
value
the Int to validate that it is positive.
returns
a Pass if the specified Int value is positive, else a Fail containing an error value produced by passing the specified Int to the given function f.
def rightOrElse[L](value: Int)(f: (Int) => L): Either[L, PosInt]
A factory/validation method that produces a PosInt, wrapped in a Right, given a valid Int value, or if the given Int is invalid, an error value of type L produced by passing the given invalid Int value to the given function f, wrapped in a Left.
A factory/validation method that produces a PosInt, wrapped in a Right, given a valid Int value, or if the given Int is invalid, an error value of type L produced by passing the given invalid Int value to the given function f, wrapped in a Left.
This method will inspect the passed Int value and if it is a positive Int, it will return a PosInt representing that value, wrapped in a Right. Otherwise, the passed Int value is not positive, so this method will return a result of type L obtained by passing the invalid Int value to the given function f, wrapped in a Left.
This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Int literals at compile time, whereas this method inspects Int values at run time.
value
the Int to inspect, and if positive, return wrapped in a Right(PosInt).
returns
the specified Int value wrapped in a Right(PosInt), if it is positive, else a Left(f(value)).
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
def tryingValid(value: Int): Try[PosInt]
A factory/validation method that produces a PosInt, wrapped in a Success, given a valid Int value, or if the given Int is invalid, an AssertionError, wrapped in a Failure.
A factory/validation method that produces a PosInt, wrapped in a Success, given a valid Int value, or if the given Int is invalid, an AssertionError, wrapped in a Failure.
This method will inspect the passed Int value and if it is a positive Int, it will return a PosInt representing that value, wrapped in a Success. Otherwise, the passed Int value is not positive, so this method will return an AssertionError, wrapped in a Failure.
This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Int literals at compile time, whereas this method inspects Int values at run time.
value
the Int to inspect, and if positive, return wrapped in a Success(PosInt).
returns
the specified Int value wrapped in a Success(PosInt), if it is positive, else a Failure(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: PosInt): Double
Implicit widening conversion from PosInt to Double.
Implicit widening conversion from PosInt to Double.
pos
the PosInt to widen
returns
the Int value underlying the specified PosInt, widened to Double.
implicit def widenToFloat(pos: PosInt): Float
Implicit widening conversion from PosInt to Float.
Implicit widening conversion from PosInt to Float.
pos
the PosInt to widen
returns
the Int value underlying the specified PosInt, widened to Float.
implicit def widenToInt(pos: PosInt): Int
Implicit widening conversion from PosInt to Int.
Implicit widening conversion from PosInt to Int.
pos
the PosInt to widen
returns
the Int value underlying the specified PosInt.
implicit def widenToLong(pos: PosInt): Long
Implicit widening conversion from PosInt to Long.
Implicit widening conversion from PosInt to Long.
pos
the PosInt to widen
returns
the Int value underlying the specified PosInt, widened to Long.
implicit def widenToNonZeroDouble(pos: PosInt): NonZeroDouble
Implicit widening conversion from PosInt to NonZeroDouble.
Implicit widening conversion from PosInt to NonZeroDouble.
pos
the PosInt to widen
returns
the Int value underlying the specified PosInt, widened to Double and wrapped in a NonZeroDouble.
implicit def widenToNonZeroFloat(pos: PosInt): NonZeroFloat
Implicit widening conversion from PosInt to NonZeroFloat.
Implicit widening conversion from PosInt to NonZeroFloat.
pos
the PosInt to widen
returns
the Int value underlying the specified PosInt, widened to Float and wrapped in a NonZeroFloat.
implicit def widenToNonZeroInt(pos: PosInt): NonZeroInt
Implicit widening conversion from PosInt to NonZeroInt.
Implicit widening conversion from PosInt to NonZeroInt.
pos
the PosInt to widen
returns
the Int value underlying the specified PosInt, widened to Int and wrapped in a NonZeroInt.
implicit def widenToNonZeroLong(pos: PosInt): NonZeroLong
Implicit widening conversion from PosInt to NonZeroLong.
Implicit widening conversion from PosInt to NonZeroLong.
pos
the PosInt to widen
returns
the Int value underlying the specified PosInt, widened to Long and wrapped in a NonZeroLong.
implicit def widenToPosDouble(pos: PosInt): PosDouble
Implicit widening conversion from PosInt to PosDouble.
Implicit widening conversion from PosInt to PosDouble.
pos
the PosInt to widen
returns
the Int value underlying the specified PosInt, widened to Double and wrapped in a PosDouble.
implicit def widenToPosFloat(pos: PosInt): PosFloat
Implicit widening conversion from PosInt to PosFloat.
Implicit widening conversion from PosInt to PosFloat.
pos
the PosInt to widen
returns
the Int value underlying the specified PosInt, widened to Float and wrapped in a PosFloat.
implicit def widenToPosLong(pos: PosInt): PosLong
Implicit widening conversion from PosInt to PosLong.
Implicit widening conversion from PosInt to PosLong.
pos
the PosInt to widen
returns
the Int value underlying the specified PosInt, widened to Long and wrapped in a PosLong.
implicit def widenToPosZDouble(pos: PosInt): PosZDouble
Implicit widening conversion from PosInt to PosZDouble.
Implicit widening conversion from PosInt to PosZDouble.
pos
the PosInt to widen
returns
the Int value underlying the specified PosInt, widened to Double and wrapped in a PosZDouble.
implicit def widenToPosZFloat(pos: PosInt): PosZFloat
Implicit widening conversion from PosInt to PosZFloat.
Implicit widening conversion from PosInt to PosZFloat.
pos
the PosInt to widen
returns
the Int value underlying the specified PosInt, widened to Float and wrapped in a PosZFloat.
implicit def widenToPosZInt(pos: PosInt): PosZInt
Implicit widening conversion from PosInt to PosZInt.
Implicit widening conversion from PosInt to PosZInt.
pos
the PosInt to widen
returns
the Int value underlying the specified PosInt, widened to Int and wrapped in a PosZInt.
implicit def widenToPosZLong(pos: PosInt): PosZLong
Implicit widening conversion from PosInt to PosZLong.
Implicit widening conversion from PosInt to PosZLong.
pos
the PosInt to widen
returns
the Int value underlying the specified PosInt, widened to Long and wrapped in a PosZLong.

Deprecated Value Members

val posIntOrd: Ordering[PosInt]
The formerly implicit posIntOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.
The formerly implicit posIntOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.
Annotations
@deprecated
Deprecated
The formerly implicit posIntOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.

Packages

PosInt

Companion class PosInt

object PosInt

Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

PosInt

Companion class PosInt

object PosInt

Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

PosInt