FailureResource

All Implemented Interfaces:

org.readium.r2.shared.fetcher.Resource , org.readium.r2.shared.util.SuspendingCloseable
```
public final class FailureResource
 implements Resource
                    
```
Creates a Resource that will always return the given error.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final File`	`file`

Constructor Summary

Constructors
Constructor	Description
`FailureResource(Link link, Resource.Exception error)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`Link`	`link()`	Returns the link from which the resource was retrieved.
`Try<ByteArray, Resource.Exception>`	`read(LongRange range)`	Reads the bytes at the given range.
`Try<Long, Resource.Exception>`	`length()`	Returns data length from metadata if available, or calculated from reading the bytes otherwise.
`Unit`	`close()`	Closes this object and releases any resources associated with it.
`String`	`toString()`

Methods inherited from class org.readium.r2.shared.fetcher.Resource
getFile, readAsBitmap, readAsJson, readAsString, readAsXml
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FailureResource
```
FailureResource(Link link, Resource.Exception error)
```
- Method Detail
  - link
```
 Link link()
```
    Returns the link from which the resource was retrieved.
    It might be modified by the Resource to include additional metadata, e.g. the Content-Type HTTP header in Link.type.
  - read
```
 Try<ByteArray, Resource.Exception> read(LongRange range)
```
    Reads the bytes at the given range.
    When range is null, the whole content is returned. Out-of-range indexes are clamped to the available length automatically.
  - length
```
 Try<Long, Resource.Exception> length()
```
    Returns data length from metadata if available, or calculated from reading the bytes otherwise.
    This value must be treated as a hint, as it might not reflect the actual bytes length. To get the real length, you need to read the whole resource.
  - close
```
 Unit close()
```
    Closes this object and releases any resources associated with it. If the object is already closed then invoking this method has no effect.
  - toString
```
 String toString()
```