object PosZInt

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

Source
PosZInt.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PosZInt
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final val MaxValue: PosZInt

    The largest value representable as a non-negative Int, which is PosZInt(2147483647).

  5. final val MinValue: PosZInt

    The smallest value representable as a non-negative Int, which is PosZInt(0).

  6. implicit macro def apply(value: Int): PosZInt

    A factory method, implemented via a macro, that produces a PosZInt if passed a valid Int literal, otherwise a compile time error.

    A factory method, implemented via a macro, that produces a PosZInt 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 PosZInt 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 PosZInt at run time.

    returns

    the specified, valid Int literal value wrapped in a PosZInt. (If the specified expression is not a valid Int literal, the invocation of this method will not compile.)

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. def ensuringValid(value: Int): PosZInt

    A factory/assertion method that produces a PosZInt given a valid Int value, or throws AssertionError, if given an invalid Int value.

    A factory/assertion method that produces a PosZInt 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 non-negative Int, it will return a PosZInt representing that value. Otherwise, the passed Int value is not non-negative, 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 non-negative.

    value

    the Int to inspect, and if non-negative, return wrapped in a PosZInt.

    returns

    the specified Int value wrapped in a PosZInt, if it is non-negative, else throws AssertionError.

    Exceptions thrown

    AssertionError if the passed value is not non-negative

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. def from(value: Int): Option[PosZInt]

    A factory method that produces an Option[PosZInt] given an Int value.

    A factory method that produces an Option[PosZInt] given an Int value.

    This method will inspect the passed Int value and if it is a non-negative Int, i.e., a non-negative integer value, it will return a PosZInt representing that value, wrapped in a Some. Otherwise, the passed Int value is not non-negative 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 non-negative, return wrapped in a Some[PosZInt].

    returns

    the specified Int value wrapped in a Some[PosZInt], if it is non-negative, else None.

  14. def fromOrElse(value: Int, default: => PosZInt): PosZInt

    A factory method that produces a PosZInt given a Int value and a default PosZInt.

    A factory method that produces a PosZInt given a Int value and a default PosZInt.

    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 PosZInt 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 PosZInt to return if the passed Int value is not positive.

    returns

    the specified Int value wrapped in a PosZInt, if it is positive, else the default PosZInt value.

  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def goodOrElse[B](value: Int)(f: (Int) => B): Or[PosZInt, B]

    A factory/validation method that produces a PosZInt, 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 PosZInt, 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 non-negative Int, it will return a PosZInt representing that value, wrapped in a Good. Otherwise, the passed Int value is not non-negative, 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 non-negative, return wrapped in a Good(PosZInt).

    returns

    the specified Int value wrapped in a Good(PosZInt), if it is non-negative, else a Bad(f(value)).

  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def isValid(value: Int): Boolean

    A predicate method that returns true if a given Int value is non-negative.

    A predicate method that returns true if a given Int value is non-negative.

    value

    the Int to inspect, and if non-negative, return true.

    returns

    true if the specified Int is non-negative, else false.

  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. implicit val ordering: Ordering[PosZInt]

    Implicit Ordering instance.

  24. 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 non-negative Int, it will return a Pass. Otherwise, the passed Int value is non-negative, 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 non-negative.

    returns

    a Pass if the specified Int value is non-negative, else a Fail containing an error value produced by passing the specified Int to the given function f.

  25. def rightOrElse[L](value: Int)(f: (Int) => L): Either[L, PosZInt]

    A factory/validation method that produces a PosZInt, 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 PosZInt, 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 non-negative Int, it will return a PosZInt representing that value, wrapped in a Right. Otherwise, the passed Int value is not non-negative, 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 non-negative, return wrapped in a Right(PosZInt).

    returns

    the specified Int value wrapped in a Right(PosZInt), if it is non-negative, else a Left(f(value)).

  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. def tryingValid(value: Int): Try[PosZInt]

    A factory/validation method that produces a PosZInt, 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 PosZInt, 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 non-negative Int, it will return a PosZInt representing that value, wrapped in a Success. Otherwise, the passed Int value is not non-negative, 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 non-negative, return wrapped in a Success(PosZInt).

    returns

    the specified Int value wrapped in a Success(PosZInt), if it is non-negative, else a Failure(AssertionError).

  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. implicit def widenToDouble(pos: PosZInt): Double

    Implicit widening conversion from PosZInt to Double.

    Implicit widening conversion from PosZInt to Double.

    pos

    the PosZInt to widen

    returns

    the Int value underlying the specified PosZInt, widened to Double.

  33. implicit def widenToFloat(pos: PosZInt): Float

    Implicit widening conversion from PosZInt to Float.

    Implicit widening conversion from PosZInt to Float.

    pos

    the PosZInt to widen

    returns

    the Int value underlying the specified PosZInt, widened to Float.

  34. implicit def widenToInt(pos: PosZInt): Int

    Implicit widening conversion from PosZInt to Int.

    Implicit widening conversion from PosZInt to Int.

    pos

    the PosZInt to widen

    returns

    the Int value underlying the specified PosZInt.

  35. implicit def widenToLong(pos: PosZInt): Long

    Implicit widening conversion from PosZInt to Long.

    Implicit widening conversion from PosZInt to Long.

    pos

    the PosZInt to widen

    returns

    the Int value underlying the specified PosZInt, widened to Long.

  36. implicit def widenToPosZDouble(pos: PosZInt): PosZDouble

    Implicit widening conversion from PosZInt to PosZDouble.

    Implicit widening conversion from PosZInt to PosZDouble.

    pos

    the PosZInt to widen

    returns

    the Int value underlying the specified PosZInt, widened to Double and wrapped in a PosZDouble.

  37. implicit def widenToPosZFloat(pos: PosZInt): PosZFloat

    Implicit widening conversion from PosZInt to PosZFloat.

    Implicit widening conversion from PosZInt to PosZFloat.

    pos

    the PosZInt to widen

    returns

    the Int value underlying the specified PosZInt, widened to Float and wrapped in a PosZFloat.

  38. implicit def widenToPosZLong(pos: PosZInt): PosZLong

    Implicit widening conversion from PosZInt to PosZLong.

    Implicit widening conversion from PosZInt to PosZLong.

    pos

    the PosZInt to widen

    returns

    the Int value underlying the specified PosZInt, widened to Long and wrapped in a PosZLong.

Deprecated Value Members

  1. val posZIntOrd: Ordering[PosZInt]

    The formerly implicit posZIntOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.

    The formerly implicit posZIntOrd 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 posZIntOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.

Inherited from AnyRef

Inherited from Any

Ungrouped