object NonZeroLong
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.
- Source
- NonZeroLong.scala
- Alphabetic
- By Inheritance
- NonZeroLong
- AnyRef
- Any
- Hide All
- Show All
- 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: NonZeroLongThe largest value representable as a non-zero Long, which isNonZeroLong(9223372036854775807).
-   final  val MinValue: NonZeroLongThe smallest value representable as a positive Long, which isNonZeroLong(-9223372036854775808).
-   implicit macro  def apply(value: Long): NonZeroLongA factory method, implemented via a macro, that produces a NonZeroLongif passed a validLongliteral, otherwise a compile time error.A factory method, implemented via a macro, that produces a NonZeroLongif passed a validLongliteral, otherwise a compile time error.The macro that implements this method will inspect the specified Longexpression at compile time. If the expression is a non-zeroLongliteral, it will return aNonZeroLongrepresenting that value. Otherwise, the passedLongexpression 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 fromfactory method in that this method is implemented via a macro that inspectsLongliterals at compile time, whereasfrominspectsLongvalues at run time.- value
- the - Longliteral expression to inspect at compile time, and if non-zero, to return wrapped in a- NonZeroLongat run time.
- returns
- the specified, valid - Longliteral value wrapped in a- NonZeroLong. (If the specified expression is not a valid- Longliteral, 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: Long): NonZeroLongA factory/assertion method that produces an NonZeroLonggiven a validLongvalue, or throwsAssertionError, if given an invalidLongvalue.A factory/assertion method that produces an NonZeroLonggiven a validLongvalue, or throwsAssertionError, if given an invalidLongvalue.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 ensuringValidcall will always succeed, you should use one of the other factory or validation methods provided on this object instead:isValid,tryingValid,passOrElse,goodOrElse, orrightOrElse.This method will inspect the passed Longvalue and if it is a non-zeroLong, it will return aNonZeroLongrepresenting that value. Otherwise, the passedLongvalue is not non-zero, so this method will throwAssertionError.This factory method differs from the applyfactory method in thatapplyis implemented via a macro that inspectsLongliterals at compile time, whereasfrominspectsLongvalues at run time. It differs from a vanillaassertorensuringcall in that you get something you didn't already have if the assertion succeeds: a type that promises aLongis positive.- value
- the - Longto inspect, and if non-zero, return wrapped in a- NonZeroLong.
- returns
- the specified - Longvalue wrapped in a- NonZeroLong, if it is non-zero, else throws- AssertionError.
 - Exceptions thrown
- AssertionErrorif the passed value is not non-zero
 
-   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: Long): Option[NonZeroLong]A factory method that produces an Option[NonZeroLong]given aLongvalue.A factory method that produces an Option[NonZeroLong]given aLongvalue.This method will inspect the passed Longvalue and if it is a non-zeroLong, it will return aNonZeroLongrepresenting that value, wrapped in aSome. Otherwise, the passedLongvalue is not non-zero, so this method will returnNone.This factory method differs from the applyfactory method in thatapplyis implemented via a macro that inspectsLongliterals at compile time, whereasfrominspectsLongvalues at run time.- value
- the - Longto inspect, and if non-zero, return wrapped in a- Some[NonZeroLong].
- returns
- the specified - Longvalue wrapped in a- Some[NonZeroLong], if it is non-zero, else- None.
 
-    def fromOrElse(value: Long, default: => NonZeroLong): NonZeroLongA factory method that produces a NonZeroLonggiven aLongvalue and a defaultNonZeroLong.A factory method that produces a NonZeroLonggiven aLongvalue and a defaultNonZeroLong.This method will inspect the passed Longvalue and if it is a non-zeroLong, it will return aNonZeroLongrepresenting that value. Otherwise, the passedLongvalue is not non-zero, so this method will return the passeddefaultvalue.This factory method differs from the applyfactory method in thatapplyis implemented via a macro that inspectsLongliterals at compile time, whereasfrominspectsLongvalues at run time.- value
- the - Longto inspect, and if non-zero, return.
- default
- the - NonZeroLongto return if the passed- Longvalue is not non-zero.
- returns
- the specified - Longvalue wrapped in a- NonZeroLong, if it is non-zero, else the- default- NonZeroLongvalue.
 
-   final  def getClass(): Class[_ <: AnyRef]- Definition Classes
- AnyRef → Any
- Annotations
- @native()
 
-    def goodOrElse[B](value: Long)(f: (Long) => B): Or[NonZeroLong, B]A factory/validation method that produces a NonZeroLong, wrapped in aGood, given a validLongvalue, or if the givenLongis invalid, an error value of typeBproduced by passing the given invalidLongvalue to the given functionf, wrapped in aBad.A factory/validation method that produces a NonZeroLong, wrapped in aGood, given a validLongvalue, or if the givenLongis invalid, an error value of typeBproduced by passing the given invalidLongvalue to the given functionf, wrapped in aBad.This method will inspect the passed Longvalue and if it is a non-zeroLong, it will return aNonZeroLongrepresenting that value, wrapped in aGood. Otherwise, the passedLongvalue is not non-zero, so this method will return a result of typeBobtained by passing the invalidLongvalue to the given functionf, wrapped in aBad.This factory method differs from the applyfactory method in thatapplyis implemented via a macro that inspectsLongliterals at compile time, whereas this method inspectsLongvalues at run time.- value
- the - Longto inspect, and if non-zero, return wrapped in a- Good(NonZeroLong).
- returns
- the specified - Longvalue wrapped in a- Good(NonZeroLong), if it is non-zero, 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: Long): BooleanA predicate method that returns true if a given Longvalue is non-zero.A predicate method that returns true if a given Longvalue is non-zero.- value
- the - Longto inspect, and if non-zero, return true.
- returns
- true if the specified - Longis non-zero, 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[NonZeroLong]Implicit Ordering instance. 
-    def passOrElse[E](value: Long)(f: (Long) => E): Validation[E]A validation method that produces a Passgiven a validLongvalue, or an error value of typeEproduced by passing the given invalidIntvalue to the given functionf, wrapped in aFail.A validation method that produces a Passgiven a validLongvalue, or an error value of typeEproduced by passing the given invalidIntvalue to the given functionf, wrapped in aFail.This method will inspect the passed Longvalue and if it is a non-zeroLong, it will return aPass. Otherwise, the passedLongvalue is non-zero, so this method will return a result of typeEobtained by passing the invalidLongvalue to the given functionf, wrapped in aFail.This factory method differs from the applyfactory method in thatapplyis implemented via a macro that inspectsLongliterals at compile time, whereas this method inspectsLongvalues at run time.- value
- the - Longto validate that it is non-zero.
- returns
- a - Passif the specified- Longvalue is non-zero, else a- Failcontaining an error value produced by passing the specified- Longto the given function- f.
 
-    def rightOrElse[L](value: Long)(f: (Long) => L): Either[L, NonZeroLong]A factory/validation method that produces a NonZeroLong, wrapped in aRight, given a validIntvalue, or if the givenIntis invalid, an error value of typeLproduced by passing the given invalidIntvalue to the given functionf, wrapped in aLeft.A factory/validation method that produces a NonZeroLong, wrapped in aRight, given a validIntvalue, or if the givenIntis invalid, an error value of typeLproduced by passing the given invalidIntvalue to the given functionf, wrapped in aLeft.This method will inspect the passed Intvalue and if it is a non-zeroInt, it will return aNonZeroLongrepresenting that value, wrapped in aRight. Otherwise, the passedIntvalue is not non-zero, so this method will return a result of typeLobtained by passing the invalidIntvalue to the given functionf, wrapped in aLeft.This factory method differs from the applyfactory method in thatapplyis implemented via a macro that inspectsIntliterals at compile time, whereas this method inspectsIntvalues at run time.- value
- the - Intto inspect, and if non-zero, return wrapped in a- Right(NonZeroLong).
- returns
- the specified - Intvalue wrapped in a- Right(NonZeroLong), if it is non-zero, 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: Long): Try[NonZeroLong]A factory/validation method that produces a NonZeroLong, wrapped in aSuccess, given a validLongvalue, or if the givenLongis invalid, anAssertionError, wrapped in aFailure.A factory/validation method that produces a NonZeroLong, wrapped in aSuccess, given a validLongvalue, or if the givenLongis invalid, anAssertionError, wrapped in aFailure.This method will inspect the passed Longvalue and if it is a non-zeroLong, it will return aNonZeroLongrepresenting that value, wrapped in aSuccess. Otherwise, the passedLongvalue is not non-zero, so this method will return anAssertionError, wrapped in aFailure.This factory method differs from the applyfactory method in thatapplyis implemented via a macro that inspectsLongliterals at compile time, whereas this method inspectsLongvalues at run time.- value
- the - Longto inspect, and if non-zero, return wrapped in a- Success(NonZeroLong).
- returns
- the specified - Longvalue wrapped in a- Success(NonZeroLong), if it is non-zero, 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: NonZeroLong): DoubleImplicit widening conversion from NonZeroLongtoDouble.Implicit widening conversion from NonZeroLongtoDouble.- pos
- the - NonZeroLongto widen
- returns
- the - Longvalue underlying the specified- NonZeroLong, widened to- Double.
 
-   implicit  def widenToFloat(pos: NonZeroLong): FloatImplicit widening conversion from NonZeroLongtoFloat.Implicit widening conversion from NonZeroLongtoFloat.- pos
- the - NonZeroLongto widen
- returns
- the - Longvalue underlying the specified- NonZeroLong, widened to- Float.
 
-   implicit  def widenToLong(pos: NonZeroLong): LongImplicit widening conversion from NonZeroLongtoLong.Implicit widening conversion from NonZeroLongtoLong.- pos
- the - NonZeroLongto widen
- returns
- the - Longvalue underlying the specified- NonZeroLong.
 
-   implicit  def widenToNonZeroDouble(pos: NonZeroLong): NonZeroDoubleImplicit widening conversion from NonZeroLongtoNonZeroDouble.Implicit widening conversion from NonZeroLongtoNonZeroDouble.- pos
- the - NonZeroLongto widen
- returns
- the - Longvalue underlying the specified- NonZeroLong, widened to- Doubleand wrapped in a- NonZeroDouble.
 
-   implicit  def widenToNonZeroFloat(pos: NonZeroLong): NonZeroFloatImplicit widening conversion from NonZeroLongtoNonZeroFloat.Implicit widening conversion from NonZeroLongtoNonZeroFloat.- pos
- the - NonZeroLongto widen
- returns
- the - Longvalue underlying the specified- NonZeroLong, widened to- Floatand wrapped in a- NonZeroFloat.