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: NonZeroInt

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

5.  final val MinValue: NonZeroInt

   The smallest value representable as a non-zero Int, which is NonZeroInt(-2147483648).

6.  implicit macro def apply(value: Int): NonZeroInt

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

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

   returns

   the specified, valid Int literal value wrapped in a NonZeroInt. (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): NonZeroInt

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

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

   value

   the Int to inspect, and if non-zero, return wrapped in a NonZeroInt.

   returns

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

   Exceptions thrown

   AssertionError if the passed value is not non-zero

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[NonZeroInt]

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

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

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

    returns

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

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

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

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

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

    returns

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

15.  final def getClass(): Class[_ <: AnyRef]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

16.  def goodOrElse[B](value: Int)(f: (Int) => B): Or[NonZeroInt, B]

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

    returns

    the specified Int value wrapped in a Good(NonZeroInt), if it is non-zero, 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-zero.

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

    value

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

    returns

    true if the specified Int is non-zero, 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[NonZeroInt]

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

    returns

    a Pass if the specified Int value is non-zero, 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, NonZeroInt]

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

    returns

    the specified Int value wrapped in a Right(NonZeroInt), if it is non-zero, 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[NonZeroInt]

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

    returns

    the specified Int value wrapped in a Success(NonZeroInt), if it is non-zero, 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: NonZeroInt): Double

    Implicit widening conversion from NonZeroInt to Double.

    Implicit widening conversion from NonZeroInt to Double.

    pos

    the NonZeroInt to widen

    returns

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

33.  implicit def widenToFloat(pos: NonZeroInt): Float

    Implicit widening conversion from NonZeroInt to Float.

    Implicit widening conversion from NonZeroInt to Float.

    pos

    the NonZeroInt to widen

    returns

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

34.  implicit def widenToInt(pos: NonZeroInt): Int

    Implicit widening conversion from NonZeroInt to Int.

    Implicit widening conversion from NonZeroInt to Int.

    pos

    the NonZeroInt to widen

    returns

    the Int value underlying the specified NonZeroInt.

35.  implicit def widenToLong(pos: NonZeroInt): Long

    Implicit widening conversion from NonZeroInt to Long.

    Implicit widening conversion from NonZeroInt to Long.

    pos

    the NonZeroInt to widen

    returns

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

36.  implicit def widenToNonZeroDouble(pos: NonZeroInt): NonZeroDouble

    Implicit widening conversion from NonZeroInt to NonZeroDouble.

    Implicit widening conversion from NonZeroInt to NonZeroDouble.

    pos

    the NonZeroInt to widen

    returns

    the Int value underlying the specified NonZeroInt, widened to Double and wrapped in a NonZeroDouble.

37.  implicit def widenToNonZeroFloat(pos: NonZeroInt): NonZeroFloat

    Implicit widening conversion from NonZeroInt to NonZeroFloat.

    Implicit widening conversion from NonZeroInt to NonZeroFloat.

    pos

    the NonZeroInt to widen

    returns

    the Int value underlying the specified NonZeroInt, widened to Float and wrapped in a NonZeroFloat.

38.  implicit def widenToNonZeroLong(pos: NonZeroInt): NonZeroLong

    Implicit widening conversion from NonZeroInt to NonZeroLong.

    Implicit widening conversion from NonZeroInt to NonZeroLong.

    pos

    the NonZeroInt to widen

    returns

    the Int value underlying the specified NonZeroInt, widened to Long and wrapped in a NonZeroLong.