final case class Invalid[+E](e: E) extends Validated[E, Nothing] with Product with Serializable
- Alphabetic
- By Inheritance
- Invalid
- Validated
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Invalid(e: E)
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
-
def
===[EE >: E, AA >: Nothing](that: Validated[EE, AA])(implicit EE: Eq[EE], AA: Eq[AA]): Boolean
- Definition Classes
- Validated
-
def
andThen[EE >: E, B](f: (Nothing) ⇒ Validated[EE, B]): Validated[EE, B]
Apply a function (that returns a
Validated
) in the valid case.Apply a function (that returns a
Validated
) in the valid case. Otherwise return the originalValidated
.This allows "chained" validation: the output of one validation can be fed into another validation function.
This function is similar to
flatMap
onEither
. It's not calledflatMap
, because by Cats convention,flatMap
is a monadic bind that is consistent withap
. This method is not consistent with ap (or otherApply
-based methods), because it has "fail-fast" behavior as opposed to accumulating validation failures.- Definition Classes
- Validated
-
def
ap[EE >: E, B](f: Validated[EE, (Nothing) ⇒ B])(implicit EE: Semigroup[EE]): Validated[EE, B]
From Apply: if both the function and this value are Valid, apply the function
From Apply: if both the function and this value are Valid, apply the function
- Definition Classes
- Validated
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
bimap[EE, AA](fe: (E) ⇒ EE, fa: (Nothing) ⇒ AA): Validated[EE, AA]
Validated is a Bifunctor, this method applies one of the given functions.
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
combine[EE >: E, AA >: Nothing](that: Validated[EE, AA])(implicit EE: Semigroup[EE], AA: Semigroup[AA]): Validated[EE, AA]
Combine this
Validated
with anotherValidated
, using theSemigroup
instances of the underlyingE
andA
instances.Combine this
Validated
with anotherValidated
, using theSemigroup
instances of the underlyingE
andA
instances. The resultantValidated
will beValid
, if, and only if, both thisValidated
instance and the suppliedValidated
instance are alsoValid
.- Definition Classes
- Validated
-
def
compare[EE >: E, AA >: Nothing](that: Validated[EE, AA])(implicit EE: Order[EE], AA: Order[AA]): Int
- Definition Classes
- Validated
- val e: E
-
def
ensure[EE >: E](onFailure: ⇒ EE)(f: (Nothing) ⇒ Boolean): Validated[EE, Nothing]
Ensure that a successful result passes the given predicate, falling back to an Invalid of
onFailure
if the predicate returns false.Ensure that a successful result passes the given predicate, falling back to an Invalid of
onFailure
if the predicate returns false.For example:
scala> Validated.valid("").ensure(new IllegalArgumentException("Must not be empty"))(_.nonEmpty) res0: Validated[IllegalArgumentException, String] = Invalid(java.lang.IllegalArgumentException: Must not be empty)
- Definition Classes
- Validated
-
def
ensureOr[EE >: E](onFailure: (Nothing) ⇒ EE)(f: (Nothing) ⇒ Boolean): Validated[EE, Nothing]
Ensure that a successful result passes the given predicate, falling back to the an Invalid of the result of
onFailure
if the predicate returns false.Ensure that a successful result passes the given predicate, falling back to the an Invalid of the result of
onFailure
if the predicate returns false.For example:
scala> Validated.valid("ab").ensureOr(s => new IllegalArgumentException("Must be longer than 3, provided '" + s + "'"))(_.length > 3) res0: Validated[IllegalArgumentException, String] = Invalid(java.lang.IllegalArgumentException: Must be longer than 3, provided 'ab')
- Definition Classes
- Validated
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
exists(predicate: (Nothing) ⇒ Boolean): Boolean
Is this Valid and matching the given predicate
Is this Valid and matching the given predicate
- Definition Classes
- Validated
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
findValid[EE >: E, AA >: Nothing](that: ⇒ Validated[EE, AA])(implicit EE: Semigroup[EE]): Validated[EE, AA]
If
this
is valid returnthis
, otherwise ifthat
is valid returnthat
, otherwise combine the failures. -
def
fold[B](fe: (E) ⇒ B, fa: (Nothing) ⇒ B): B
- Definition Classes
- Validated
-
def
foldLeft[B](b: B)(f: (B, Nothing) ⇒ B): B
apply the given function to the value with the given B when valid, otherwise return the given B
apply the given function to the value with the given B when valid, otherwise return the given B
- Definition Classes
- Validated
-
def
foldRight[B](lb: Eval[B])(f: (Nothing, Eval[B]) ⇒ Eval[B]): Eval[B]
Lazily-apply the given function to the value with the given B when valid, otherwise return the given B.
Lazily-apply the given function to the value with the given B when valid, otherwise return the given B.
- Definition Classes
- Validated
-
def
forall(f: (Nothing) ⇒ Boolean): Boolean
Is this Invalid or matching the predicate
Is this Invalid or matching the predicate
- Definition Classes
- Validated
-
def
foreach(f: (Nothing) ⇒ Unit): Unit
Run the side-effecting function on the value if it is Valid
Run the side-effecting function on the value if it is Valid
- Definition Classes
- Validated
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getOrElse[B >: Nothing](default: ⇒ B): B
Return the Valid value, or the default if Invalid
Return the Valid value, or the default if Invalid
- Definition Classes
- Validated
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isInvalid: Boolean
- Definition Classes
- Validated
-
def
isValid: Boolean
- Definition Classes
- Validated
-
def
leftMap[EE](f: (E) ⇒ EE): Validated[EE, Nothing]
Apply a function to an Invalid value, returning a new Invalid value.
Apply a function to an Invalid value, returning a new Invalid value. Or, if the original valid was Valid, return it.
- Definition Classes
- Validated
-
def
map[B](f: (Nothing) ⇒ B): Validated[E, B]
Apply a function to a Valid value, returning a new Valid value
Apply a function to a Valid value, returning a new Valid value
- Definition Classes
- Validated
-
def
merge[EE >: E](implicit ev: <:<[Nothing, EE]): EE
- Definition Classes
- Validated
-
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()
-
def
orElse[EE, AA >: Nothing](default: ⇒ Validated[EE, AA]): Validated[EE, AA]
Return this if it is Valid, or else fall back to the given default.
-
def
partialCompare[EE >: E, AA >: Nothing](that: Validated[EE, AA])(implicit EE: PartialOrder[EE], AA: PartialOrder[AA]): Double
- Definition Classes
- Validated
-
def
product[EE >: E, B](fb: Validated[EE, B])(implicit EE: Semigroup[EE]): Validated[EE, (Nothing, B)]
From Product
From Product
- Definition Classes
- Validated
-
def
show[EE >: E, AA >: Nothing](implicit EE: Show[EE], AA: Show[AA]): String
- Definition Classes
- Validated
-
def
swap: Validated[Nothing, E]
- Definition Classes
- Validated
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toEither: Either[E, Nothing]
Converts the value to an Either[E, A]
Converts the value to an Either[E, A]
- Definition Classes
- Validated
-
def
toIor: Ior[E, Nothing]
Returns Valid values wrapped in Ior.Right, and None for Ior.Left values
Returns Valid values wrapped in Ior.Right, and None for Ior.Left values
- Definition Classes
- Validated
-
def
toList: List[Nothing]
Convert this value to a single element List if it is Valid, otherwise return an empty List
Convert this value to a single element List if it is Valid, otherwise return an empty List
- Definition Classes
- Validated
-
def
toOption: Option[Nothing]
Returns Valid values wrapped in Some, and None for Invalid values
Returns Valid values wrapped in Some, and None for Invalid values
- Definition Classes
- Validated
-
def
toValidatedNel[EE >: E, AA >: Nothing]: ValidatedNel[EE, AA]
Lift the Invalid value into a NonEmptyList.
Lift the Invalid value into a NonEmptyList.
- Definition Classes
- Validated
-
def
traverse[F[_], EE >: E, B](f: (Nothing) ⇒ F[B])(implicit F: Applicative[F]): F[Validated[EE, B]]
When Valid, apply the function, marking the result as valid inside the Applicative's context, when Invalid, lift the Error into the Applicative's context
When Valid, apply the function, marking the result as valid inside the Applicative's context, when Invalid, lift the Error into the Applicative's context
- Definition Classes
- Validated
-
def
valueOr[B >: Nothing](f: (E) ⇒ B): B
Return the Valid value, or the result of f if Invalid
Return the Valid value, or the result of f if Invalid
- Definition Classes
- Validated
-
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
- @native() @throws( ... )
-
def
withEither[EE, B](f: (Either[E, Nothing]) ⇒ Either[EE, B]): Validated[EE, B]
Convert to an Either, apply a function, convert back.
Convert to an Either, apply a function, convert back. This is handy when you want to use the Monadic properties of the Either type.
- Definition Classes
- Validated