Класс scala.util.Try

Компаньон объект Try

запечатанный абстрактный класс Try[+T] extends Product with Serializable

Тип Try представляет вычисление, которое может либо завершиться исключением, либо вернуть успешно вычисленное значение. Он похож на, но семантически отличается от типа scala.util.Either.

Экземпляры Try[T], являются либо экземпляром scala.util.Success[T], либо scala.util.Failure[T].

Например, Try можно использовать для выполнения деления на пользовательский ввод, без необходимости явного обработки исключений во всех местах, где может возникнуть исключение.

Пример:

import scala.io.StdIn
import scala.util.{Try, Success, Failure}

def divide: Try[Int] = {
  val dividend = Try(StdIn.readLine("Enter an Int that you'd like to divide:\n").toInt)
  val divisor = Try(StdIn.readLine("Enter an Int that you'd like to divide by:\n").toInt)
  val problem = dividend.flatMap(x => divisor.map(y => x/y))
  problem match {
    case Success(v) =>
      println("Result of " + dividend.get + "/"+ divisor.get +" is: " + v)
      Success(v)
    case Failure(e) =>
      println("You must've divided by zero or entered something that's not an Int. Try again!")
      println("Info from the exception: " + e.getMessage)
      divide
  }
}

Важным свойством Try, показанным в приведенном выше примере, является возможность поточной обработки или цепочки операций, перехватывая исключения по пути. Комбинаторы flatMap и map в приведенном выше примере фактически передают либо успешно завершенное значение, обернутое в тип Success для дальнейшей обработки следующим комбинатором в цепочке, либо исключение, обернутое в тип Failure обычно для простого его прохождения по цепочке. Комбинаторы, такие как recover и recoverWith, предназначены для обеспечения некоторого поведения по умолчанию в случае ошибки.

Примечание: только некритические исключения перехватываются комбинаторами на Try (см. scala.util.control.NonFatal). Серьёзные системные ошибки, с другой стороны, будут выброшены.

Примечание: все комбинаторы Try будут перехватывать исключения и возвращать ошибку, если не указано иное в документации.

Try появился в стандартной библиотеке Scala после многолетнего использования в качестве составной части стека Twitter.

Источник: Try.scala
С: 2.10

Линейные супертипы

Известные подклассы

Члены типа

класс WithFilter extends AnyRef

Нам нужен целый класс WithFilter, чтобы соблюсти контракт "не создаёт новую коллекцию", даже если вряд ли это будет иметь значение в коллекции с максимальным размером 1.

Аннотации: @deprecatedInheritance( сообщение = ... , с = "2.12.0" )

Члены-значения абстрактного типа

abstract def canEqual(that: Any): Boolean

Метод, который следует вызывать из каждого хорошо спроектированного метода equals, который может быть переопределён в подклассе. См. Programming in Scala, Глава 28 для обсуждения и проектирования.

that: значение, проверяемое на возможность равенства
returns: true, если этот экземпляр может быть равен that, иначе false

Definition Classes: Equals

abstract def collect[U](pf: PartialFunction[T, U]): Try[U]

abstract def failed: Try[Throwable]

Инвертирует этот Try. Если это Failure, возвращает исключение, заключенное в Success. Если это Success, возвращает Failure, содержащую UnsupportedOperationException.

abstract def filter(p: (T) ⇒ Boolean): Try[T]

abstract def flatMap[U](f: (T) ⇒ Try[U]): Try[U]

abstract def flatten[U](implicit ev: <:<[T, Try[U]]): Try[U]

abstract def fold[U](fa: (Throwable) ⇒ U, fb: (T) ⇒ U): U

Применяет fa если это Failure или fb если это Success. Если fb применяется вначале и выбрасывает исключение, то применяется fa с этим исключением.

fa: функция, применяемая, если это Failure
fb: функция, применяемая, если это Success
returns: результаты применения функции

Пример:

val result: Try[Throwable, Int] = Try { string.toInt }
log(result.fold(
  ex => "Operation failed with " + ex,
  v => "Operation produced value: " + v
))

abstract def foreach[U](f: (T) ⇒ U): Unit

Применяет заданную функцию f если это Success, в противном случае возвращает Unit если это Failure.

Примечание: Если f вызывает исключение, то этот метод может вызвать исключение.

abstract def get: T

abstract def getOrElse[U >: T](default: ⇒ U): U

Возвращает значение из этого Success или заданное значение default аргумент, если это Failure.

Примечание: Это вызовет исключение, если это не успех, а default вызывает исключение.

abstract def isFailure: Boolean

abstract def isSuccess: Boolean

abstract def map[U](f: (T) ⇒ U): Try[U]

abstract def orElse[U >: T](default: ⇒ Try[U]): Try[U]

abstract def productArity: Int

Размер этого продукта.

returns: для продукта A(x₁, ..., x_k), возвращает k

Definition Classes: Product

abstract def productElement(n: Int): Any

n-ый элемент этого продукта, нумерация с 0. Другими словами, для продукта A(x₁, ..., x_k), возвращает x_(n+1), где 0 <= n < k.

n: индекс возвращаемого элемента
returns: элемент n элементы после первого элемента

Definition Classes: Product
Exceptions thrown

abstract def recover[U >: T](pf: PartialFunction[Throwable, U]): Try[U]

Применяет заданную функцию f если это Failure, в противном случае возвращает текущее значение, если это Success. Это как map для исключения.

abstract def recoverWith[U >: T](pf: PartialFunction[Throwable, Try[U]]): Try[U]

Применяет заданную функцию f если это Failure, в противном случае возвращает текущее значение, если это Success. Это как flatMap для исключения.

abstract def toEither: Either[Throwable, T]

abstract def toOption: Option[T]

abstract def transform[U](s: (T) ⇒ Try[U], f: (Throwable) ⇒ Try[U]): Try[U]

Члены-значения конкретного типа

final def !=(arg0: Any): Boolean

Проверка двух объектов на неравенство.

возвращает: true если !(this == that), в противном случае false.

Определяющие классы: AnyRef → Any

final def ##(): Int

Эквивалентно x.hashCode за исключением упакованных числовых типов и null. Для чисел он возвращает значение хеша, согласованное с равенством по значению: если два экземпляра типа значения сравниваются как true, то ## будет генерировать одинаковое значение хеша для каждого из них. Для null возвращает хешкод, где null.hashCode вызывает NullPointerException.

возвращает: значение хеша, согласованное с ==

Определяющие классы: AnyRef → Any

def +(other: String): String

Неявный: Этот член добавлен неявным преобразованием из Try[T] в any2stringadd[Try[T]], выполненное методом any2stringadd в scala.Predef.
Определяющие классы: any2stringadd

def ->[B](y: B): (Try[T], B)

Неявный: Этот член добавлен неявным преобразованием из Try[T] в ArrowAssoc[Try[T]], выполненное методом ArrowAssoc в scala.Predef.
Определяющие классы: ArrowAssoc
Аннотации: @inline()

final def ==(arg0: Any): Boolean

Выражение x == that эквивалентно if (x eq null) that eq null else x.equals(that).

возвращает: true если объект-получатель эквивалентен аргументу; false в противном случае.

Определяющие классы: AnyRef → Any

final def asInstanceOf[T0]: T0

Привести объект-получатель к типу T0.

Обратите внимание, что успех приведения во время выполнения зависит от семантики стирания в Scala. Поэтому выражение 1.asInstanceOf[String] выбросит ClassCastException во время выполнения, в то время как выражение List(1).asInstanceOf[List[String]] не выбросит. В последнем примере, поскольку тип аргумента стирается при компиляции, проверить, соответствуют ли содержимое списка запрошенному типу, невозможно.

возвращает: объект-получатель.

Определяющие классы: Any
Исключения: ClassCastException если объект-получатель не является экземпляром стирания типа T0.

def clone(): AnyRef

Создать копию объекта-получателя.

По умолчанию реализация метода clone зависит от платформы.

возвращает: копия объекта-получателя.

Атрибуты: protected[lang]
Определяющие классы: AnyRef
Аннотации: @throws( ... ) @native()
Примечание: не определен SLS как член AnyRef

def ensuring(cond: (Try[T]) ⇒ Boolean, msg: ⇒ Any): Try[T]

Неявный: Этот член добавлен неявным преобразованием из Try[T] в Ensuring[Try[T]], выполненное методом Ensuring в scala.Predef.
Определяющие классы: Ensuring

def ensuring(cond: (Try[T]) ⇒ Boolean): Try[T]

Неявный: Этот член добавлен неявным преобразованием из Try[T] в Ensuring[Try[T]], выполненное методом Ensuring в scala.Predef.
Определяющие классы: Ensuring

def ensuring(cond: Boolean, msg: ⇒ Any): Try[T]

Неявный: Этот член добавлен неявным преобразованием из Try[T] в Ensuring[Try[T]], выполненным методом Ensuring в scala.Predef.
Классы определений: Ensuring

def ensuring(cond: Boolean): Try[T]

Неявный: Этот член добавлен неявным преобразованием из Try[T] в Ensuring[Try[T]], выполненным методом Ensuring в scala.Predef.
Классы определений: Ensuring

final def eq(arg0: AnyRef): Boolean

Проверяет, является ли аргумент (that) ссылкой на объект-получатель (this).

Метод eq реализует отношение эквивалентности на непустых экземплярах AnyRef, и обладает тремя дополнительными свойствами:

x

y

AnyRef

x.eq(y)

true

false

x

AnyRef

x.eq(null)

null.eq(x)

false

null.eq(null)

true

При переопределении методов equals или hashCode важно обеспечить согласованность их поведения с равенством ссылок. Поэтому, если два объекта являются ссылками друг на друга (o1 eq o2), они должны быть равны друг другу (o1 == o2) и должны хешироваться к одному значению (o1.hashCode == o2.hashCode).

возвращает: true если аргумент является ссылкой на объект-получатель; false в противном случае.

Классы определений: AnyRef

def equals(arg0: Any): Boolean

Метод равенства для ссылочных типов. Реализация по умолчанию делегирует вызов методу eq.

См. также equals в scala.Any.

возвращает: true если объект-получатель эквивалентен аргументу; false в противном случае.

Классы определений: AnyRef → Any

def finalize(): Unit

Вызывается сборщиком мусора для объекта-получателя, когда к объекту больше нет ссылок.

Детали того, когда и если вызывается метод finalize, а также взаимодействие finalize с нелокальными возвратами и исключениями, зависят от платформы.

Атрибуты: protected[lang]
Классы определений: AnyRef
Аннотации: @throws( classOf[java.lang.Throwable] )
Примечание: не указан SLS в качестве члена AnyRef

def formatted(fmtstr: String): String

Возвращает строку, отформатированную в соответствии с данной строкой format. Форматные строки аналогичны String.format (@см. java.lang.String.format).

Неявный: Этот член добавлен неявным преобразованием из Try[T] в StringFormat[Try[T]] выполненным методом StringFormat в scala.Predef.
Классы определений: StringFormat
Аннотации: @inline()

final def getClass(): Class[_]

Возвращает представление класса объекта во время выполнения.

возвращает: объект класса, соответствующий типу получателя во время выполнения.

Классы определений: AnyRef → Any
Аннотации: @native()

def hashCode(): Int

Метод hashCode для ссылочных типов. См. hashCode в scala.Any.

возвращает: значение хэш-кода для этого объекта.

Классы определений: AnyRef → Any
Аннотации: @native()

final def isInstanceOf[T0]: Boolean

Проверяет, является ли динамический тип объекта-получателя T0.

Обратите внимание, что результат проверки зависит от стирания типов в Scala. Поэтому выражение 1.isInstanceOf[String] вернёт false, в то время как выражение List(1).isInstanceOf[List[String]] вернёт true. В последнем примере, потому что тип аргумента стирается во время компиляции, проверить, являются ли элементы списка указанного типа, нельзя.

возвращает: true если объект-получатель является экземпляром стираемого типа T0; false в противном случае.

Классы определений: Any

final def ne(arg0: AnyRef): Boolean

Эквивалентно !(this eq that).

возвращает: true если аргумент не является ссылкой на объект-получатель; false в противном случае.

Классы определений: AnyRef

final def notify(): Unit

Разбуждает единственную нить, ожидающую монитора объекта-приемника.

Классы-определения: AnyRef
Аннотации: @native()
Примечание: не указано SLS как член AnyRef

final def notifyAll(): Unit

Разбуждает все нити, ожидающие монитора объекта-приемника.

Классы-определения: AnyRef
Аннотации: @native()
Примечание: не указано SLS как член AnyRef

def productIterator: Iterator[Any]

Итератор по всем элементам этого произведения.

возвращает: в реализации по умолчанию, Iterator[Any]

Классы-определения: Product

def productPrefix: String

Строка, используемая в методах toString производных классов. Реализации могут переопределить этот метод, чтобы добавить префикс к строке результата методов toString.

возвращает: в реализации по умолчанию, пустая строка

Классы-определения: Product

final def synchronized[T0](arg0: ⇒ T0): T0

Классы-определения: AnyRef

def toString(): String

Создаёт строковое представление этого объекта. По умолчанию представление зависит от платформы. На платформе Java это конкатенация имени класса, «@» и хэш-кода объекта в шестнадцатеричном формате.

возвращает: строковое представление объекта.

Классы-определения: AnyRef → Any

final def wait(): Unit

Классы-определения: AnyRef
Аннотации: @throws( ... )

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

Классы-определения: AnyRef
Аннотации: @throws( ... )

final def wait(arg0: Long): Unit

Классы-определения: AnyRef
Аннотации: @throws( ... ) @native()

final def withFilter(p: (T) ⇒ Boolean): WithFilter

Создаёт нестрогий фильтр, который в конечном итоге преобразует это в Failure, если предикат не выполняется.

Примечание: в отличие от filter, withFilter не создаёт нового Try. Вместо этого он ограничивает область применения последующих map, flatMap, foreach, и withFilter операций.

Поскольку Try является коллекцией из одного элемента, это может быть несколько избыточно, но это соответствует withFilter для Option и других коллекций.

p: предикат, используемый для проверки элементов.
возвращает: объект класса WithFilter, который поддерживает map, flatMap, foreach, и withFilter операции. Все эти операции применяются к тем элементам этого Try, которые удовлетворяют предикату p.

Аннотации: @inline()

def →[B](y: B): (Try[T], B)

Неявный: Этот член добавлен неявным преобразованием из Try[T] в ArrowAssoc[Try[T]], выполненное методом ArrowAssoc в scala.Predef.
Классы-определения: ArrowAssoc

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.12.9/scala/util/Try.html