Scalactic 3.2.13 - org.scalactic.anyvals.NegInt

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

The largest value representable as a negative Int, which is NegInt(-1).

final val MinValue: NegInt

The smallest value representable as a negative Int, which is NegInt(-2147483648).

implicit macro def apply(value: Int): NegInt

A factory method, implemented via a macro, that produces a NegInt 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 NegInt 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 NegInt at run time.
returns: the specified, valid Int literal value wrapped in a NegInt. (If the specified expression is not a valid Int literal, 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( ... ) @native()

def ensuringValid(value: Int): NegInt

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

value: the Int to inspect, and if negative, return wrapped in a NegInt.
returns: the specified Int value wrapped in a NegInt, if it is negative, else throws AssertionError.

Exceptions thrown: AssertionError if the passed value is not negative

final def eq(arg0: AnyRef): Boolean

Definition Classes: AnyRef

def equals(arg0: Any): Boolean

Definition Classes: AnyRef → Any

def finalize(): Unit

Attributes: protected[lang]
Definition Classes: AnyRef
Annotations: @throws( classOf[java.lang.Throwable] )

def from(value: Int): Option[NegInt]

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

This method will inspect the passed Int value and if it is a negative Int, i.e., a negative integer value, it will return a NegInt representing that value, wrapped in a Some. Otherwise, the passed Int value is not negative 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 negative, return wrapped in a Some[NegInt].
returns: the specified Int value wrapped in a Some[NegInt], if it is negative, else None.

def fromOrElse(value: Int, default: ⇒ NegInt): NegInt

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

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 NegInt 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 NegInt to return if the passed Int value is not positive.
returns: the specified Int value wrapped in a NegInt, if it is positive, else the default NegInt value.

final def getClass(): Class[_]

Definition Classes: AnyRef → Any
Annotations: @native()

def goodOrElse[B](value: Int)(f: (Int) ⇒ B): Or[NegInt, B]

A factory/validation method that produces a NegInt, 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 negative Int, it will return a NegInt representing that value, wrapped in a Good. Otherwise, the passed Int value is not negative, 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 negative, return wrapped in a Good(NegInt).
returns: the specified Int value wrapped in a Good(NegInt), if it is negative, 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: Int): Boolean

A predicate method that returns true if a given Int value is negative.

value: the Int to inspect, and if negative, return true.
returns: true if the specified Int is negative, 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[NegInt]

Implicit Ordering instance.

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.

This method will inspect the passed Int value and if it is a negative Int, it will return a Pass. Otherwise, the passed Int value is negative, 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 negative.
returns: a Pass if the specified Int value is negative, else a Fail containing an error value produced by passing the specified Int to the given function f.

def rightOrElse[L](value: Int)(f: (Int) ⇒ L): Either[L, NegInt]

A factory/validation method that produces a NegInt, 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 negative Int, it will return a NegInt representing that value, wrapped in a Right. Otherwise, the passed Int value is not negative, 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 negative, return wrapped in a Right(NegInt).
returns: the specified Int value wrapped in a Right(NegInt), if it is negative, 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: Int): Try[NegInt]

A factory/validation method that produces a NegInt, 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 negative Int, it will return a NegInt representing that value, wrapped in a Success. Otherwise, the passed Int value is not negative, 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 negative, return wrapped in a Success(NegInt).
returns: the specified Int value wrapped in a Success(NegInt), if it is negative, else a Failure(AssertionError).

final def wait(): Unit

Definition Classes: AnyRef
Annotations: @throws( ... )

final def wait(arg0: Long, arg1: Int): Unit

Definition Classes: AnyRef
Annotations: @throws( ... )

final def wait(arg0: Long): Unit

Definition Classes: AnyRef
Annotations: @throws( ... ) @native()

implicit def widenToDouble(pos: NegInt): Double

Implicit widening conversion from NegInt to Double.

pos: the NegInt to widen
returns: the Int value underlying the specified NegInt, widened to Double.

implicit def widenToFloat(pos: NegInt): Float

Implicit widening conversion from NegInt to Float.

pos: the NegInt to widen
returns: the Int value underlying the specified NegInt, widened to Float.

implicit def widenToInt(pos: NegInt): Int

Implicit widening conversion from NegInt to Int.

pos: the NegInt to widen
returns: the Int value underlying the specified NegInt.

implicit def widenToLong(pos: NegInt): Long

Implicit widening conversion from NegInt to Long.

pos: the NegInt to widen
returns: the Int value underlying the specified NegInt, widened to Long.

implicit def widenToNegDouble(pos: NegInt): NegDouble

Implicit widening conversion from NegInt to NegDouble.

pos: the NegInt to widen
returns: the Int value underlying the specified NegInt, widened to Double and wrapped in a NegDouble.

implicit def widenToNegFloat(pos: NegInt): NegFloat

Implicit widening conversion from NegInt to NegFloat.

pos: the NegInt to widen
returns: the Int value underlying the specified NegInt, widened to Float and wrapped in a NegFloat.

implicit def widenToNegLong(pos: NegInt): NegLong

Implicit widening conversion from NegInt to NegLong.

pos: the NegInt to widen
returns: the Int value underlying the specified NegInt, widened to Long and wrapped in a NegLong.

implicit def widenToNegZDouble(pos: NegInt): NegZDouble

Implicit widening conversion from NegInt to NegZDouble.

pos: the NegInt to widen
returns: the Int value underlying the specified NegInt, widened to Double and wrapped in a NegZDouble.

implicit def widenToNegZFloat(pos: NegInt): NegZFloat

Implicit widening conversion from NegInt to NegZFloat.

pos: the NegInt to widen
returns: the Int value underlying the specified NegInt, widened to Float and wrapped in a NegZFloat.

implicit def widenToNegZInt(pos: NegInt): NegZInt

Implicit widening conversion from NegInt to NegZInt.

pos: the NegInt to widen
returns: the Int value underlying the specified NegInt, widened to Int and wrapped in a NegZInt.

implicit def widenToNegZLong(pos: NegInt): NegZLong

Implicit widening conversion from NegInt to NegZLong.

pos: the NegInt to widen
returns: the Int value underlying the specified NegInt, widened to Long and wrapped in a NegZLong.

implicit def widenToNonZeroDouble(pos: NegInt): NonZeroDouble

Implicit widening conversion from NegInt to NonZeroDouble.

pos: the NegInt to widen
returns: the Int value underlying the specified NegInt, widened to Double and wrapped in a NonZeroDouble.

implicit def widenToNonZeroFloat(pos: NegInt): NonZeroFloat

Implicit widening conversion from NegInt to NonZeroFloat.

pos: the NegInt to widen
returns: the Int value underlying the specified NegInt, widened to Float and wrapped in a NonZeroFloat.

implicit def widenToNonZeroInt(pos: NegInt): NonZeroInt

Implicit widening conversion from NegInt to NonZeroInt.

pos: the NegInt to widen
returns: the Int value underlying the specified NegInt, widened to Int and wrapped in a NonZeroInt.

implicit def widenToNonZeroLong(pos: NegInt): NonZeroLong

Implicit widening conversion from NegInt to NonZeroLong.

pos: the NegInt to widen
returns: the Int value underlying the specified NegInt, widened to Long and wrapped in a NonZeroLong.

Packages

NegInt

Companion class NegInt

object NegInt

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

NegInt 

Companion class NegInt

object NegInt

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

NegInt