The companion object for NonZeroLong that offers
factory methods that produce NonZeroLongs, implicit
widening conversions from NonZeroLong to other
numeric types, and maximum and minimum constant values for
NonZeroLong.
- Companion:
- class
- Source:
- NonZeroLong.scala
Value members
Concrete methods
A factory/assertion method that produces an NonZeroLong given a
valid Long value, or throws AssertionError,
if given an invalid Long value.
A factory/assertion method that produces an NonZeroLong given a
valid Long value, or throws AssertionError,
if given an invalid Long 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 Long value and if
it is a non-zero Long, it will return a NonZeroLong representing that value.
Otherwise, the passed Long 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 Long literals at
compile time, whereas from inspects
Long 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 a Long is positive.
- Value parameters:
- value
the
Longto inspect, and if non-zero, return wrapped in aNonZeroLong.
- Returns:
the specified
Longvalue wrapped in aNonZeroLong, if it is non-zero, else throwsAssertionError.- Throws:
- AssertionError
if the passed value is not non-zero
- Source:
- NonZeroLong.scala
A factory method that produces an Option[NonZeroLong] given a
Long value.
A factory method that produces an Option[NonZeroLong] given a
Long value.
This method will inspect the passed Long value and if
it is a non-zero Long, it will return a NonZeroLong representing that value,
wrapped in a Some. Otherwise, the passed Long
value is not non-zero, 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 Long literals at
compile time, whereas from inspects
Long values at run time.
- Value parameters:
- value
the
Longto inspect, and if non-zero, return wrapped in aSome[NonZeroLong].
- Returns:
the specified
Longvalue wrapped in aSome[NonZeroLong], if it is non-zero, elseNone.- Source:
- NonZeroLong.scala
A factory method that produces a NonZeroLong given a
Long value and a default NonZeroLong.
A factory method that produces a NonZeroLong given a
Long value and a default NonZeroLong.
This method will inspect the passed Long value and if
it is a non-zero Long, it will return a NonZeroLong representing that value.
Otherwise, the passed Long value is not non-zero, 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 Long literals at
compile time, whereas from inspects
Long values at run time.
- Value parameters:
- default
the
NonZeroLongto return if the passedLongvalue is not non-zero.- value
the
Longto inspect, and if non-zero, return.
- Returns:
the specified
Longvalue wrapped in aNonZeroLong, if it is non-zero, else thedefaultNonZeroLongvalue.- Source:
- NonZeroLong.scala
A factory/validation method that produces a NonZeroLong, wrapped
in a Good, given a valid Long value, or if the
given Long is invalid, an error value of type B
produced by passing the given invalid Long value
to the given function f, wrapped in a Bad.
A factory/validation method that produces a NonZeroLong, wrapped
in a Good, given a valid Long value, or if the
given Long is invalid, an error value of type B
produced by passing the given invalid Long value
to the given function f, wrapped in a Bad.
This method will inspect the passed Long value and if
it is a non-zero Long, it will return a NonZeroLong
representing that value, wrapped in a Good.
Otherwise, the passed Long value is not non-zero, so this
method will return a result of type B obtained by passing
the invalid Long 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
Long literals at compile time, whereas this method inspects
Long values at run time.
- Value parameters:
- value
the
Longto inspect, and if non-zero, return wrapped in aGood(NonZeroLong).
- Returns:
the specified
Longvalue wrapped in aGood(NonZeroLong), if it is non-zero, else aBad(f(value)).- Source:
- NonZeroLong.scala
A predicate method that returns true if a given
Long value is non-zero.
A predicate method that returns true if a given
Long value is non-zero.
- Value parameters:
- value
the
Longto inspect, and if non-zero, return true.
- Returns:
true if the specified
Longis non-zero, else false.- Source:
- NonZeroLong.scala
A validation method that produces a Pass
given a valid Long 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 Long 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 Long value and if
it is a non-zero Long, it will return a Pass.
Otherwise, the passed Long value is non-zero, so this
method will return a result of type E obtained by passing
the invalid Long 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
Long literals at compile time, whereas this method inspects
Long values at run time.
- Value parameters:
- value
the
Longto validate that it is non-zero.
- Returns:
a
Passif the specifiedLongvalue is non-zero, else aFailcontaining an error value produced by passing the specifiedLongto the given functionf.- Source:
- NonZeroLong.scala
A factory/validation method that produces a NonZeroLong, 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 NonZeroLong, 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 NonZeroLong
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 parameters:
- value
the
Intto inspect, and if non-zero, return wrapped in aRight(NonZeroLong).
- Returns:
the specified
Intvalue wrapped in aRight(NonZeroLong), if it is non-zero, else aLeft(f(value)).- Source:
- NonZeroLong.scala
A factory/validation method that produces a NonZeroLong, wrapped
in a Success, given a valid Long value, or if the
given Long is invalid, an AssertionError, wrapped
in a Failure.
A factory/validation method that produces a NonZeroLong, wrapped
in a Success, given a valid Long value, or if the
given Long is invalid, an AssertionError, wrapped
in a Failure.
This method will inspect the passed Long value and if
it is a non-zero Long, it will return a NonZeroLong
representing that value, wrapped in a Success.
Otherwise, the passed Long 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
Long literals at compile time, whereas this method inspects
Long values at run time.
- Value parameters:
- value
the
Longto inspect, and if non-zero, return wrapped in aSuccess(NonZeroLong).
- Returns:
the specified
Longvalue wrapped in aSuccess(NonZeroLong), if it is non-zero, else aFailure(AssertionError).- Source:
- NonZeroLong.scala
Concrete fields
The largest value representable as a non-zero
Long, which is NonZeroLong(9223372036854775807).
The largest value representable as a non-zero
Long, which is NonZeroLong(9223372036854775807).
- Source:
- NonZeroLong.scala
The smallest value representable as a positive
Long, which is NonZeroLong(-9223372036854775808).
The smallest value representable as a positive
Long, which is NonZeroLong(-9223372036854775808).
- Source:
- NonZeroLong.scala
Implicits
Implicits
A factory method, implemented via a macro, that produces a
NonZeroLong if passed a valid Long
literal, otherwise a compile time error.
A factory method, implemented via a macro, that produces a
NonZeroLong if passed a valid Long
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 non-zero Long literal,
it will return a NonZeroLong representing that value.
Otherwise, the passed Long expression is either a literal
that is not non-zero, 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 Long literals at compile
time, whereas from inspects Long
values at run time.
- Value parameters:
- value
the
Longliteral expression to inspect at compile time, and if non-zero, to return wrapped in aNonZeroLongat run time.
- Returns:
the specified, valid
Longliteral value wrapped in aNonZeroLong. (If the specified expression is not a validLongliteral, the invocation of this method will not compile.)- Source:
- NonZeroLong.scala
Implicit widening conversion from NonZeroLong to
Double.
Implicit widening conversion from NonZeroLong to
Double.
- Value parameters:
- pos
the
NonZeroLongto widen
- Returns:
the
Longvalue underlying the specifiedNonZeroLong, widened toDouble.- Source:
- NonZeroLong.scala
Implicit widening conversion from NonZeroLong to
Float.
Implicit widening conversion from NonZeroLong to
Float.
- Value parameters:
- pos
the
NonZeroLongto widen
- Returns:
the
Longvalue underlying the specifiedNonZeroLong, widened toFloat.- Source:
- NonZeroLong.scala
Implicit widening conversion from NonZeroLong to
Long.
Implicit widening conversion from NonZeroLong to
Long.
- Value parameters:
- pos
the
NonZeroLongto widen
- Returns:
the
Longvalue underlying the specifiedNonZeroLong.- Source:
- NonZeroLong.scala
Implicit widening conversion from NonZeroLong to NonZeroDouble.
Implicit widening conversion from NonZeroLong to NonZeroDouble.
- Value parameters:
- pos
the
NonZeroLongto widen
- Returns:
the
Longvalue underlying the specifiedNonZeroLong, widened toDoubleand wrapped in aNonZeroDouble.- Source:
- NonZeroLong.scala
Implicit widening conversion from NonZeroLong to NonZeroFloat.
Implicit widening conversion from NonZeroLong to NonZeroFloat.
- Value parameters:
- pos
the
NonZeroLongto widen
- Returns:
the
Longvalue underlying the specifiedNonZeroLong, widened toFloatand wrapped in aNonZeroFloat.- Source:
- NonZeroLong.scala