SingleRequest (glide API)

java.lang.Object
- com.bumptech.glide.request.SingleRequest<R>

Type Parameters:

R - The type of the resource that will be transcoded from the loaded resource.

All Implemented Interfaces:

Request, ResourceCallback, SizeReadyCallback, FactoryPools.Poolable
```
public final class SingleRequest<R>
extends Object
implements Request, SizeReadyCallback, ResourceCallback, FactoryPools.Poolable
```
A Request that loads a Resource into a given Target.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`begin()` Starts an asynchronous load.
`void`	`clear()` Cancels the current load if it is in progress, clears any resources held onto by the request and replaces the loaded resource if the load completed with the placeholder.
`StateVerifier`	`getVerifier()`
`boolean`	`isCancelled()` Returns true if the request has been cancelled.
`boolean`	`isComplete()` Returns true if the request has completed successfully.
`boolean`	`isEquivalentTo(Request o)` Returns `true` if this `Request` is equivalent to the given `Request` (has all of the same options and sizes).
`boolean`	`isFailed()` Returns true if the request has failed.
`boolean`	`isPaused()` Returns true if this request is paused and may be restarted.
`boolean`	`isResourceSet()` Returns true if a non-placeholder resource is put.
`boolean`	`isRunning()` Returns true if this request is running and has not completed or failed.
`static <R> SingleRequest<R>`	`obtain(Context context, GlideContext glideContext, Object model, Class<R> transcodeClass, RequestOptions requestOptions, int overrideWidth, int overrideHeight, Priority priority, Target<R> target, RequestListener<R> targetListener, RequestListener<R> requestListener, RequestCoordinator requestCoordinator, Engine engine, TransitionFactory<? super R> animationFactory)`
`void`	`onLoadFailed(GlideException e)` A callback method that should never be invoked directly.
`void`	`onResourceReady(Resource<?> resource, DataSource dataSource)` A callback method that should never be invoked directly.
`void`	`onSizeReady(int width, int height)` A callback method that should never be invoked directly.
`void`	`pause()` Identical to `Request.clear()` except that the request may later be restarted.
`void`	`recycle()` Recycles the request object and releases its resources.

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

- Method Detail
  - obtain
```
public static <R> SingleRequest<R> obtain(Context context,
                                          GlideContext glideContext,
                                          Object model,
                                          Class<R> transcodeClass,
                                          RequestOptions requestOptions,
                                          int overrideWidth,
                                          int overrideHeight,
                                          Priority priority,
                                          Target<R> target,
                                          RequestListener<R> targetListener,
                                          RequestListener<R> requestListener,
                                          RequestCoordinator requestCoordinator,
                                          Engine engine,
                                          TransitionFactory<? super R> animationFactory)
```
  - getVerifier
```
public StateVerifier getVerifier()
```
    Specified by:
    
    getVerifier in interface FactoryPools.Poolable
  - recycle
```
public void recycle()
```
    Description copied from interface: Request
    
    Recycles the request object and releases its resources.
    
    Specified by:
    
    recycle in interface Request
  - begin
```
public void begin()
```
    Description copied from interface: Request
    
    Starts an asynchronous load.
    
    Specified by:
    
    begin in interface Request
  - clear
```
public void clear()
```
    Cancels the current load if it is in progress, clears any resources held onto by the request and replaces the loaded resource if the load completed with the placeholder.
    Cleared requests can be restarted with a subsequent call to begin()
    
    Specified by:
    
    clear in interface Request
    
    See Also:
    
    cancel()
  - isPaused
```
public boolean isPaused()
```
    Description copied from interface: Request
    
    Returns true if this request is paused and may be restarted.
    
    Specified by:
    
    isPaused in interface Request
  - pause
```
public void pause()
```
    Description copied from interface: Request
    
    Identical to Request.clear() except that the request may later be restarted.
    
    Specified by:
    
    pause in interface Request
  - isRunning
```
public boolean isRunning()
```
    Description copied from interface: Request
    
    Returns true if this request is running and has not completed or failed.
    
    Specified by:
    
    isRunning in interface Request
  - isComplete
```
public boolean isComplete()
```
    Description copied from interface: Request
    
    Returns true if the request has completed successfully.
    
    Specified by:
    
    isComplete in interface Request
  - isResourceSet
```
public boolean isResourceSet()
```
    Description copied from interface: Request
    
    Returns true if a non-placeholder resource is put. For Requests that load more than one resource, isResourceSet may return true even if Request.isComplete()} returns false.
    
    Specified by:
    
    isResourceSet in interface Request
  - isCancelled
```
public boolean isCancelled()
```
    Description copied from interface: Request
    
    Returns true if the request has been cancelled.
    
    Specified by:
    
    isCancelled in interface Request
  - isFailed
```
public boolean isFailed()
```
    Description copied from interface: Request
    
    Returns true if the request has failed.
    
    Specified by:
    
    isFailed in interface Request
  - onSizeReady
```
public void onSizeReady(int width,
                        int height)
```
    A callback method that should never be invoked directly.
    
    Specified by:
    
    onSizeReady in interface SizeReadyCallback
    
    Parameters:
    
    width - The width in pixels of the target, or Target.SIZE_ORIGINAL to indicate that we want the resource at its original width.
    
    height - The height in pixels of the target, or Target.SIZE_ORIGINAL to indicate that we want the resource at its original height.
  - onResourceReady
```
public void onResourceReady(Resource<?> resource,
                            DataSource dataSource)
```
    A callback method that should never be invoked directly.
    
    Specified by:
    
    onResourceReady in interface ResourceCallback
    
    Parameters:
    
    resource - The loaded resource.
  - onLoadFailed
```
public void onLoadFailed(GlideException e)
```
    A callback method that should never be invoked directly.
    
    Specified by:
    
    onLoadFailed in interface ResourceCallback
    
    Parameters:
    
    e - a non-null GlideException.
  - isEquivalentTo
```
public boolean isEquivalentTo(Request o)
```
    Description copied from interface: Request
    
    Returns true if this Request is equivalent to the given Request (has all of the same options and sizes).
    This method is identical to Object.equals(Object) except that it's specific to Request subclasses. We do not use Object.equals(Object) directly because we track Requests in collections like Set and it's perfectly legitimate to have two different Request objects for two different Targets (for example). Using a similar but different method let's us selectively compare Request objects to each other when it's useful in specific scenarios.
    
    Specified by:
    
    isEquivalentTo in interface Request

Class SingleRequest<R>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

obtain

getVerifier

recycle

begin

clear

isPaused

pause

isRunning

isComplete

isResourceSet

isCancelled

isFailed

onSizeReady

onResourceReady

onLoadFailed

isEquivalentTo