Spec-Zone.ru › Scala 2.12 Library

Класс scala.util.Failure

final case class Failure[+T](exception: Throwable) extends Try[T] with Product with Serializable

Источник
Try.scala
Линейные супертипы

Конструкторы экземпляров

new Failure(exception: Throwable)

Члены типов

class WithFilter extends AnyRef

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

Определяющие классы
Try
Аннотации
@deprecatedInheritance( message = ... , since = "2.12.0" )

Члены-значения

final def !=(arg0: Any): Boolean

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

returns

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

Definition Classes
AnyRef → Any

final def ##(): Int

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

returns

значение хэша, согласованное с ==

Definition Classes
AnyRef → Any

def +(other: String): String

Неявный
Этот член добавлен неявным преобразованием из Failure[T] в any2stringadd[Failure[T]], выполненное методом any2stringadd в scala.Predef.
Definition Classes
any2stringadd

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

Неявный
Этот член добавлен неявным преобразованием из Failure[T] в ArrowAssoc[Failure[T]], выполненное методом ArrowAssoc в scala.Predef.
Definition Classes
ArrowAssoc
Аннотации
@inline()

final def ==(arg0: Any): Boolean

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

returns

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

Definition Classes
AnyRef → Any

final def asInstanceOf[T0]: T0

Преобразовать объект-приёмник к типу T0.

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

returns

объект-приёмник.

Definition Classes
Any
Исключения

ClassCastException если объект-приёмник не является экземпляром стираемого типа T0.

def clone(): AnyRef

Создать копию объекта-приёмника.

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

returns

копия объекта-приёмника.

Атрибуты
protected[lang]
Definition Classes
AnyRef
Аннотации
@throws( ... ) @native()
Примечание

не определён SLS как член AnyRef

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

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

Definition Classes
Failure → Try

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

Неявный
Этот член добавлен неявным преобразованием из Failure[T] в Ensuring[Failure[T]] выполненным методом Ensuring в scala.Predef.
Definition Classes
Ensuring

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

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

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

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

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

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

final def eq(arg0: AnyRef): Boolean

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

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

    Он согласован: для любых не-null экземпляров x и y типа AnyRef, многократные вызовы x.eq(y) последовательно возвращают true или последовательно возвращают false.Для любого не-null экземпляра 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

val exception: Throwable

def failed: Try[Throwable]

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

Классы определения
Failure → Try

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

Преобразует это в Failure если предикат не удовлетворён.

Классы определения
Failure → Try

def finalize(): Unit

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

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

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

не указано SLS в качестве члена AnyRef

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

Возвращает результат применения заданной функции к значению из этого Success или возвращает это значение, если это Failure.

Классы определения
Failure → Try

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

Преобразует вложенное Try, т.е. Try типа Try[Try[T]], в не-вложенное Try, т.е. Try типа Try[T].

Классы определения
Failure → Try

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

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

fa

функция, применяемая, если это Failure

fb

функция, применяемая, если это Success

returns

результаты применения функции

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

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

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

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

Definition Classes
Failure → Try

def formatted(fmtstr: String): String

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

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

def get: T

Возвращает значение из этого Success или выбрасывает исключение, если это Failure.

Definition Classes
Failure → Try

final def getClass(): Class[_]

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

returns

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

Definition Classes
AnyRef → Any
Annotations
@native()

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

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

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

Definition Classes
Failure → Try

def isFailure: Boolean

Возвращает true , если Try является Failure, false в противном случае.

Definition Classes
Failure → Try

final def isInstanceOf[T0]: Boolean

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

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

returns

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

Definition Classes
Any

def isSuccess: Boolean

Возвращает true , если Try является Success, false в противном случае.

Definition Classes
Failure → Try

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

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

Definition Classes
Failure → Try

final def ne(arg0: AnyRef): Boolean

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

returns

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

Definition Classes
AnyRef

final def notify(): Unit

Разбуждает один поток, ожидающий на мониторе объекта-получателя.

Definition Classes
AnyRef
Annotations
@native()
Примечание

не указано SLS в качестве члена AnyRef

final def notifyAll(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Note

не указано SLS как члена AnyRef

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

Возвращает этот Try объект, если он является Success, или заданный default аргумент, если это Failure.

Definition Classes
Failure → Try

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

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

Definition Classes
Failure → Try

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

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

Definition Classes
Failure → Try

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

Definition Classes
AnyRef

def toEither: Either[Throwable, T]

Возвращает Left с Throwable, если это Failure, в противном случае возвращает Right с Success значением.

Definition Classes
Failure → Try

def toOption: Option[T]

Возвращает None , если это Failure или Some , содержащий значение, если это Success.

Definition Classes
Failure → Try

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

Завершает этот Try , применив функцию f к этому объекту, если он типа Failure, или, наоборот, применив s, если это Success.

Definition Classes
Failure → Try

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()

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

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

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

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

p

предикат, используемый для проверки элементов.

returns

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

Definition Classes
Try
Annotations
@inline()

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

Implicit
Этот член добавлен неявным преобразованием из Failure[T] в ArrowAssoc[Failure[T]], выполненным методом ArrowAssoc в scala.Predef.
Definition Classes
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/Failure.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API