Failure (OpenGamma Strata Collect)

java.lang.Object
- com.opengamma.strata.collect.result.Failure

All Implemented Interfaces:

Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean
```
public final class Failure
extends Object
implements org.joda.beans.ImmutableBean, Serializable
```
Description of a failed result.
If calculation of a result fails this class provides details of the failure. There is a single reason and message and a set of detailed failure items. Each FailureItem has details of the actual cause.
In most cases, instances of Failure should be created using one of the failure methods on Result.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Failure.Meta
The meta-bean for Failure.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Failure.Meta` The meta-bean for `Failure`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`FailureItem`	`getFirstItem()` Gets the first failure item.
`ImmutableSet<FailureItem>`	`getItems()` Gets the set of failure items.
`String`	`getMessage()` Gets the error message associated with the failure.
`FailureReason`	`getReason()` Gets the reason associated with the failure.
`int`	`hashCode()`
`static Failure.Meta`	`meta()` The meta-bean for `Failure`.
`Failure.Meta`	`metaBean()`
`static Failure`	`of(Collection<FailureItem> items)` Obtains a failure for a non-empty collection of failure items.
`static Failure`	`of(FailureItem item)` Obtains a failure for a single failure item.
`static Failure`	`of(FailureItem item, FailureItem... additionalItems)` Obtains a failure for multiple failure items.
`static Failure`	`of(FailureReason reason, Exception cause)` Obtains a failure from a reason and exception.
`static Failure`	`of(FailureReason reason, Exception cause, String message, Object... messageArgs)` Obtains a failure from a reason, message and exception.
`static Failure`	`of(FailureReason reason, String message, Object... messageArgs)` Obtains a failure from a reason and message.
`static Failure`	`of(FailureReason reason, Throwable cause)` Obtains a failure from a reason and throwable.
`static Failure`	`of(FailureReason reason, Throwable cause, String message, Object... messageArgs)` Obtains a failure from a reason, message and throwable.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.joda.beans.Bean
property, propertyNames

- Method Detail
  - of
```
public static Failure of(FailureReason reason,
                         String message,
                         Object... messageArgs)
```
    Obtains a failure from a reason and message.
    The message is produced using a template that contains zero to many "{}" placeholders. Each placeholder is replaced by the next available argument. If there are too few arguments, then the message will be left with placeholders. If there are too many arguments, then the excess arguments are appended to the end of the message. No attempt is made to format the arguments. See Messages.format(String, Object...) for more details.
    An exception will be created internally to obtain a stack trace. The cause type will not be present in the resulting failure.
    
    Parameters:
    
    reason - the reason
    
    message - a message explaining the failure, not empty, uses "{}" for inserting messageArgs
    
    messageArgs - the arguments for the message
    
    Returns:
    
    the failure
  - of
```
public static Failure of(FailureReason reason,
                         Throwable cause,
                         String message,
                         Object... messageArgs)
```
    Obtains a failure from a reason, message and throwable.
    The message is produced using a template that contains zero to many "{}" placeholders. Each placeholder is replaced by the next available argument. If there are too few arguments, then the message will be left with placeholders. If there are too many arguments, then the excess arguments are appended to the end of the message. No attempt is made to format the arguments. See Messages.format(String, Object...) for more details.
    
    Parameters:
    
    reason - the reason
    
    cause - the cause
    
    message - the failure message, possibly containing placeholders, formatted using Messages.format(java.lang.String, java.lang.Object)
    
    messageArgs - arguments used to create the failure message
    
    Returns:
    
    the failure
  - of
```
public static Failure of(FailureReason reason,
                         Exception cause,
                         String message,
                         Object... messageArgs)
```
    Obtains a failure from a reason, message and exception.
    The message is produced using a template that contains zero to many "{}" placeholders. Each placeholder is replaced by the next available argument. If there are too few arguments, then the message will be left with placeholders. If there are too many arguments, then the excess arguments are appended to the end of the message. No attempt is made to format the arguments. See Messages.format(String, Object...) for more details.
    
    Parameters:
    
    reason - the reason
    
    cause - the cause
    
    message - the failure message, possibly containing placeholders, formatted using Messages.format(java.lang.String, java.lang.Object)
    
    messageArgs - arguments used to create the failure message
    
    Returns:
    
    the failure
  - of
```
public static Failure of(FailureReason reason,
                         Throwable cause)
```
    Obtains a failure from a reason and throwable.
    
    Parameters:
    
    reason - the reason
    
    cause - the cause
    
    Returns:
    
    the failure
  - of
```
public static Failure of(FailureReason reason,
                         Exception cause)
```
    Obtains a failure from a reason and exception.
    
    Parameters:
    
    reason - the reason
    
    cause - the cause
    
    Returns:
    
    the failure
  - of
```
public static Failure of(FailureItem item)
```
    Obtains a failure for a single failure item.
    
    Parameters:
    
    item - the failure item
    
    Returns:
    
    the failure
  - of
```
public static Failure of(FailureItem item,
                         FailureItem... additionalItems)
```
    Obtains a failure for multiple failure items.
    
    Parameters:
    
    item - the first failure item
    
    additionalItems - additional failure items
    
    Returns:
    
    the failure
  - of
```
public static Failure of(Collection<FailureItem> items)
```
    Obtains a failure for a non-empty collection of failure items.
    
    Parameters:
    
    items - the failures, not empty
    
    Returns:
    
    the failure
  - getFirstItem
```
public FailureItem getFirstItem()
```
    Gets the first failure item.
    There will be at least one failure item, so this always succeeds.
    
    Returns:
    
    the failure item
  - meta
```
public static Failure.Meta meta()
```
    The meta-bean for Failure.
    
    Returns:
    
    the meta-bean, not null
  - metaBean
```
public Failure.Meta metaBean()
```
    Specified by:
    
    metaBean in interface org.joda.beans.Bean
  - getReason
```
public FailureReason getReason()
```
    Gets the reason associated with the failure.
    
    Returns:
    
    the value of the property, not null
  - getMessage
```
public String getMessage()
```
    Gets the error message associated with the failure.
    
    Returns:
    
    the value of the property, not empty
  - getItems
```
public ImmutableSet<FailureItem> getItems()
```
    Gets the set of failure items. There will be at least one failure item.
    
    Returns:
    
    the value of the property, not empty
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Copyright 2009-Present by OpenGamma Inc. and individual contributors
Apache v2 licensed
Additional documentation can be found at strata.opengamma.io.

Class Failure

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.joda.beans.Bean

Method Detail

of

of

of

of

of

of

of

of

getFirstItem

meta

metaBean

getReason

getMessage

getItems

equals

hashCode

toString