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
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NonZeroLong
  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: NonZeroLong

    The largest value representable as a non-zero Long, which is NonZeroLong(9223372036854775807).

  5. final val MinValue: NonZeroLong

    The smallest value representable as a positive Long, which is NonZeroLong(-9223372036854775808).

  6. implicit macro def apply(value: Long): NonZeroLong

    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

    the Long literal expression to inspect at compile time, and if non-zero, to return wrapped in a NonZeroLong at run time.

    returns

    the specified, valid Long literal value wrapped in a NonZeroLong. (If the specified expression is not a valid Long 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: Long): NonZeroLong

    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

    the Long to inspect, and if non-zero, return wrapped in a NonZeroLong.

    returns

    the specified Long value wrapped in a NonZeroLong, 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: Long): Option[NonZeroLong]

    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

    the Long to inspect, and if non-zero, return wrapped in a Some[NonZeroLong].

    returns

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

  14. def fromOrElse(value: Long, default: => NonZeroLong): NonZeroLong

    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

    the Long to inspect, and if non-zero, return.

    default

    the NonZeroLong to return if the passed Long value is not non-zero.

    returns

    the specified Long value wrapped in a NonZeroLong, if it is non-zero, else the default NonZeroLong value.

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

    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

    the Long to inspect, and if non-zero, return wrapped in a Good(NonZeroLong).

    returns

    the specified Long value wrapped in a Good(NonZeroLong), 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: Long): Boolean

    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

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

    returns

    true if the specified Long 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[NonZeroLong]

    Implicit Ordering instance.

  24. def passOrElse[E](value: Long)(f: (Long) => E): Validation[E]

    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

    the Long to validate that it is non-zero.

    returns

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

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

    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

    the Int to inspect, and if non-zero, return wrapped in a Right(NonZeroLong).

    returns

    the specified Int value wrapped in a Right(NonZeroLong), 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: Long): Try[NonZeroLong]

    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

    the Long to inspect, and if non-zero, return wrapped in a Success(NonZeroLong).

    returns

    the specified Long value wrapped in a Success(NonZeroLong), 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: NonZeroLong): Double

    Implicit widening conversion from NonZeroLong to Double.

    Implicit widening conversion from NonZeroLong to Double.

    pos

    the NonZeroLong to widen

    returns

    the Long value underlying the specified NonZeroLong, widened to Double.

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

    Implicit widening conversion from NonZeroLong to Float.

    Implicit widening conversion from NonZeroLong to Float.

    pos

    the NonZeroLong to widen

    returns

    the Long value underlying the specified NonZeroLong, widened to Float.

  34. implicit def widenToLong(pos: NonZeroLong): Long

    Implicit widening conversion from NonZeroLong to Long.

    Implicit widening conversion from NonZeroLong to Long.

    pos

    the NonZeroLong to widen

    returns

    the Long value underlying the specified NonZeroLong.

  35. implicit def widenToNonZeroDouble(pos: NonZeroLong): NonZeroDouble

    Implicit widening conversion from NonZeroLong to NonZeroDouble.

    Implicit widening conversion from NonZeroLong to NonZeroDouble.

    pos

    the NonZeroLong to widen

    returns

    the Long value underlying the specified NonZeroLong, widened to Double and wrapped in a NonZeroDouble.

  36. implicit def widenToNonZeroFloat(pos: NonZeroLong): NonZeroFloat

    Implicit widening conversion from NonZeroLong to NonZeroFloat.

    Implicit widening conversion from NonZeroLong to NonZeroFloat.

    pos

    the NonZeroLong to widen

    returns

    the Long value underlying the specified NonZeroLong, widened to Float and wrapped in a NonZeroFloat.

Inherited from AnyRef

Inherited from Any

Ungrouped