NonZeroInt
Related Docs:
class NonZeroInt
| package anyvals
The largest value representable as a non-zero Int, which is NonZeroInt(2147483647).
The largest value representable as a non-zero Int, which is NonZeroInt(2147483647).
The smallest value representable as a non-zero Int, which is NonZeroInt(-2147483648).
The smallest value representable as a non-zero Int, which is NonZeroInt(-2147483648).
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.
the Int literal expression to inspect at compile time,
and if positive, to return wrapped in a NonZeroInt at run time.
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.)
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.
the Int to inspect, and if non-zero, return
wrapped in a NonZeroInt.
the specified Int value wrapped
in a NonZeroInt, if it is non-zero, else throws AssertionError.
AssertionError if the passed value is not non-zero
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.
the Int to inspect, and if non-zero, return
wrapped in a Some[NonZeroInt].
the specified Int value wrapped
in a Some[NonZeroInt], if it is non-zero, else None.
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.
the Int to inspect, and if positive, return.
the NonZeroInt to return if the passed
Int value is not positive.
the specified Int value wrapped in a
NonZeroInt, if it is positive, else the
default NonZeroInt value.
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.
the Int to inspect, and if non-zero, return
wrapped in a Good(NonZeroInt).
the specified Int value wrapped
in a Good(NonZeroInt), if it is non-zero, else a Bad(f(value)).
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.
the Int to inspect, and if non-zero, return true.
true if the specified Int is non-zero, else false.
Implicit Ordering instance.
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.
the Int to validate that it is non-zero.
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.
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.
the Int to inspect, and if non-zero, return
wrapped in a Right(NonZeroInt).
the specified Int value wrapped
in a Right(NonZeroInt), if it is non-zero, else a Left(f(value)).
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.
the Int to inspect, and if non-zero, return
wrapped in a Success(NonZeroInt).
the specified Int value wrapped
in a Success(NonZeroInt), if it is non-zero, else a Failure(AssertionError).
Implicit widening conversion from NonZeroInt to Double.
Implicit widening conversion from NonZeroInt to Double.
the NonZeroInt to widen
the Int value underlying the specified NonZeroInt,
widened to Double.
Implicit widening conversion from NonZeroInt to Float.
Implicit widening conversion from NonZeroInt to Float.
the NonZeroInt to widen
the Int value underlying the specified NonZeroInt,
widened to Float.
Implicit widening conversion from NonZeroInt to Int.
Implicit widening conversion from NonZeroInt to Int.
the NonZeroInt to widen
the Int value underlying the specified NonZeroInt.
Implicit widening conversion from NonZeroInt to Long.
Implicit widening conversion from NonZeroInt to Long.
the NonZeroInt to widen
the Int value underlying the specified NonZeroInt,
widened to Long.
Implicit widening conversion from NonZeroInt to NonZeroDouble.
Implicit widening conversion from NonZeroInt to NonZeroDouble.
the NonZeroInt to widen
the Int value underlying the specified NonZeroInt,
widened to Double and wrapped in a NonZeroDouble.
Implicit widening conversion from NonZeroInt to NonZeroFloat.
Implicit widening conversion from NonZeroInt to NonZeroFloat.
the NonZeroInt to widen
the Int value underlying the specified NonZeroInt,
widened to Float and wrapped in a NonZeroFloat.
Implicit widening conversion from NonZeroInt to NonZeroLong.
Implicit widening conversion from NonZeroInt to NonZeroLong.
the NonZeroInt to widen
the Int value underlying the specified NonZeroInt,
widened to Long and wrapped in a NonZeroLong.
The companion object for
NonZeroIntthat offers factory methods that produceNonZeroInts, implicit widening conversions fromNonZeroIntto other numeric types, and maximum and minimum constant values forNonZeroInt.