scala.util

# Success

#### final case class Success[+T](value: T) extends Try[T] with Product with Serializable

Linear Supertypes
Serializable, java.io.Serializable, Product, Equals, Try[T], AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. Success
2. Serializable
3. Serializable
4. Product
5. Equals
6. Try
7. AnyRef
8. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show all

Learn more about member selection
Visibility

1. Public
2. All

### Instance Constructors

1. #### new Success(value: T)

### Type Members

1. #### class WithFilter extends AnyRef

   We need a whole WithFilter class to honor the "doesn't create a new collection" contract even though it seems unlikely to matter much in a collection with max size 1.

### Value Members

1. #### final def !=(arg0: Any): Boolean

   Definition Classes
     AnyRef → Any

2. #### final def ##(): Int

   Definition Classes
     AnyRef → Any

3. #### def +(other: String): String

   Implicit information
     This member is added by an implicit conversion from Success[T] to any2stringadd[Success[T]] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd

4. #### def ->[B](y: B): (Success[T], B)

   Implicit information
     This member is added by an implicit conversion from Success[T] to ArrowAssoc[Success[T]] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()

5. #### final def ==(arg0: Any): Boolean

   Definition Classes
     AnyRef → Any

6. #### final def asInstanceOf[T0]: T0

   Definition Classes
     Any

7. #### def clone(): AnyRef

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

8. #### def ensuring(cond: (Success[T]) ⇒ Boolean, msg: ⇒ Any): Success[T]

   Implicit information
     This member is added by an implicit conversion from Success[T] to Ensuring[Success[T]] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring

9. #### def ensuring(cond: (Success[T]) ⇒ Boolean): Success[T]

   Implicit information
     This member is added by an implicit conversion from Success[T] to Ensuring[Success[T]] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring

10. #### def ensuring(cond: Boolean, msg: ⇒ Any): Success[T]

    Implicit information
      This member is added by an implicit conversion from Success[T] to Ensuring[Success[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring

11. #### def ensuring(cond: Boolean): Success[T]

    Implicit information
      This member is added by an implicit conversion from Success[T] to Ensuring[Success[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring

12. #### final def eq(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

13. #### def failed: Try[Throwable]

    Completes this `Try` with an exception wrapped in a `Success`.

    Completes this `Try` with an exception wrapped in a `Success`. The exception is either the exception that the `Try` failed with (if a `Failure`) or an `UnsupportedOperationException`.

    Definition Classes
      Success → Try

14. #### def filter(p: (T) ⇒ Boolean): Try[T]

    Converts this to a `Failure` if the predicate is not satisfied.

    Converts this to a `Failure` if the predicate is not satisfied.

    Definition Classes
      Success → Try

15. #### def finalize(): Unit

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

16. #### def flatMap[U](f: (T) ⇒ Try[U]): Try[U]

    Returns the given function applied to the value from this `Success` or returns this if this is a `Failure`.

    Returns the given function applied to the value from this `Success` or returns this if this is a `Failure`.

    Definition Classes
      Success → Try

17. #### def flatten[U](implicit ev: <:<[T, Try[U]]): Try[U]

    Transforms a nested `Try`, ie, a `Try` of type `Try[Try[T]]`, into an un-nested `Try`, ie, a `Try` of type `Try[T]`.

    Transforms a nested `Try`, ie, a `Try` of type `Try[Try[T]]`, into an un-nested `Try`, ie, a `Try` of type `Try[T]`.

    Definition Classes
      Success → Try

18. #### def foreach[U](f: (T) ⇒ U): Unit

    Applies the given function `f` if this is a `Success`, otherwise returns `Unit` if this is a `Failure`.

    Applies the given function `f` if this is a `Success`, otherwise returns `Unit` if this is a `Failure`.

    Note: If `f` throws, then this method may throw an exception.

    Definition Classes
      Success → Try

19. #### def formatted(fmtstr: String): String

    Returns string formatted according to given `format` string.

    Returns string formatted according to given `format` string. Format strings are as for `String.format` (@see java.lang.String.format).

    Implicit information
      This member is added by an implicit conversion from Success[T] to StringFormat[Success[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
      StringFormat
    Annotations
      @inline()

20. #### def get: T

    Returns the value from this `Success` or throws the exception if this is a `Failure`.

    Returns the value from this `Success` or throws the exception if this is a `Failure`.

    Definition Classes
      Success → Try

21. #### final def getClass(): Class[_]

    Definition Classes
      AnyRef → Any

22. #### def getOrElse[U >: T](default: ⇒ U): U

    Returns the value from this `Success` or the given `default` argument if this is a `Failure`.

    Returns the value from this `Success` or the given `default` argument if this is a `Failure`.

    Note:: This will throw an exception if it is not a success and default throws an exception.

    Definition Classes
      Try

23. #### def isFailure: Boolean

    Returns `true` if the `Try` is a `Failure`, `false` otherwise.

    Returns `true` if the `Try` is a `Failure`, `false` otherwise.

    Definition Classes
      Success → Try

24. #### final def isInstanceOf[T0]: Boolean

    Definition Classes
      Any

25. #### def isSuccess: Boolean

    Returns `true` if the `Try` is a `Success`, `false` otherwise.

    Returns `true` if the `Try` is a `Success`, `false` otherwise.

    Definition Classes
      Success → Try

26. #### def map[U](f: (T) ⇒ U): Try[U]

    Maps the given function to the value from this `Success` or returns this if this is a `Failure`.

    Maps the given function to the value from this `Success` or returns this if this is a `Failure`.

    Definition Classes
      Success → Try

27. #### final def ne(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

28. #### final def notify(): Unit

    Definition Classes
      AnyRef

29. #### final def notifyAll(): Unit

    Definition Classes
      AnyRef

30. #### def orElse[U >: T](default: ⇒ Try[U]): Try[U]

    Returns this `Try` if it's a `Success` or the given `default` argument if this is a `Failure`.

    Returns this `Try` if it's a `Success` or the given `default` argument if this is a `Failure`.

    Definition Classes
      Try

31. #### def recover[U >: T](rescueException: PartialFunction[Throwable, U]): Try[U]

    Applies the given function `f` if this is a `Failure`, otherwise returns this if this is a `Success`.

    Applies the given function `f` if this is a `Failure`, otherwise returns this if this is a `Success`. This is like map for the exception.

    Definition Classes
      Success → Try

32. #### def recoverWith[U >: T](f: PartialFunction[Throwable, Try[U]]): Try[U]

    Applies the given function `f` if this is a `Failure`, otherwise returns this if this is a `Success`.

    Applies the given function `f` if this is a `Failure`, otherwise returns this if this is a `Success`. This is like `flatMap` for the exception.

    Definition Classes
      Success → Try

33. #### final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
      AnyRef

34. #### def toOption: Option[T]

    Returns `None` if this is a `Failure` or a `Some` containing the value if this is a `Success`.

    Returns `None` if this is a `Failure` or a `Some` containing the value if this is a `Success`.

    Definition Classes
      Try

35. #### def transform[U](s: (T) ⇒ Try[U], f: (Throwable) ⇒ Try[U]): Try[U]

    Completes this `Try` by applying the function `f` to this if this is of type `Failure`, or conversely, by applying `s` if this is a `Success`.

    Completes this `Try` by applying the function `f` to this if this is of type `Failure`, or conversely, by applying `s` if this is a `Success`.

    Definition Classes
      Try

36. #### val value: T

37. #### final def wait(): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

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

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

39. #### final def wait(arg0: Long): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

40. #### final def withFilter(p: (T) ⇒ Boolean): WithFilter

    Creates a non-strict filter, which eventually converts this to a `Failure` if the predicate is not satisfied.

    Creates a non-strict filter, which eventually converts this to a `Failure` if the predicate is not satisfied.

    Note: unlike filter, withFilter does not create a new Try. Instead, it restricts the domain of subsequent `map`, `flatMap`, `foreach`, and `withFilter` operations.

    As Try is a one-element collection, this may be a bit overkill, but it's consistent with withFilter on Option and the other collections.

    p

      the predicate used to test elements.

    returns

      an object of class `WithFilter`, which supports `map`, `flatMap`, `foreach`, and `withFilter` operations. All these operations apply to those elements of this Try which satisfy the predicate `p`.

    Definition Classes
      Try
    Annotations
      @inline()

41. #### def →[B](y: B): (Success[T], B)

    Implicit information
      This member is added by an implicit conversion from Success[T] to ArrowAssoc[Success[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
      ArrowAssoc

### Inherited from Serializable

### Inherited from java.io.Serializable

### Inherited from Product

### Inherited from Equals

### Inherited from Try[T]

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd from Success[T] to any2stringadd[Success[T]]

### Inherited by implicit conversion StringFormat from Success[T] to StringFormat[Success[T]]

### Inherited by implicit conversion Ensuring from Success[T] to Ensuring[Success[T]]

### Inherited by implicit conversion ArrowAssoc from Success[T] to ArrowAssoc[Success[T]]

### Ungrouped