BaseLoader (Yakhont-full 0.9.19 API)

java.lang.Object
- android.content.Loader<BaseResponse<R,E,D>>
- - akha.yakhont.loader.BaseLoader<C,R,E,D>

Type Parameters:
C - The type of callback
R - The type of network response
E - The type of error (if any)
D - The type of data in this loader

Direct Known Subclasses:

CacheLoader
```
public abstract class BaseLoader<C,R,E,D>
extends Loader<BaseResponse<R,E,D>>
```
A class that performs asynchronous loading of data. After loading completion, the registered callback will be called. See setCallback().

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`BaseLoader.CoreLoadBuilder<R,E,D>` Builder class for `BaseResponseLoaderWrapper.CoreLoad` objects.
`static class`	`BaseLoader.CoreLoadExtendedBuilder<C,R,E,D,T>` Builder class for `BaseResponseLoaderWrapper.CoreLoad` objects.
`static class`	`BaseLoader.ProgressWrapper` The `ProgressWrapper` class is intended to display a data loading progress to the user.

Nested classes/interfaces inherited from class android.content.Loader
Loader.ForceLoadContentObserver, Loader.OnLoadCanceledListener<D>, Loader.OnLoadCompleteListener<D>

Constructor Summary

Constructors
Constructor and Description
`BaseLoader(Context context)` Initialises a newly created `BaseLoader` object.
`BaseLoader(Context context, int resId)` Initialises a newly created `BaseLoader` object.
`BaseLoader(Context context, int resId, String logDescription)` Initialises a newly created `BaseLoader` object.
`BaseLoader(Context context, String description)` Initialises a newly created `BaseLoader` object.
`BaseLoader(Context context, String description, String logDescription)` Initialises a newly created `BaseLoader` object.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`callbackHelper(boolean success, BaseResponse<R,E,D> baseResponse)` Subject to call from the callback (see `setCallback()`).
`protected void`	`deliver(BaseResponse<R,E,D> baseResponse)` Delivers the results of loading.
`void`	`deliverResult(BaseResponse<R,E,D> data)` Please refer to the base method description.
`static boolean`	`destroyLoader(LoaderManager loaderManager, int loaderId)` Destroys loader with the given ID.
`static void`	`destroyLoaders(LoaderManager loaderManager, Collection<Integer> loaderIds)` Destroys loaders.
`static BaseResponseLoaderWrapper.CoreLoad`	`getCoreLoad(Activity activity)` Returns the `CoreLoad` component for the given activity.
`static BaseResponseLoaderWrapper.CoreLoad`	`getCoreLoad(Fragment fragment)` Returns the `CoreLoad` component for the given fragment.
`protected void`	`makeRequest()` Starts an asynchronous load.
`protected abstract void`	`makeRequest(C callback)` Starts an asynchronous load.
`protected void`	`onFailure(BaseResponse<R,E,D> baseResponse)` Callback which is called after NOT successful data loading.
`protected void`	`onForceLoad()` Please refer to the base method description.
`protected void`	`onReset()` Please refer to the base method description.
`protected void`	`onStartLoading()` Please refer to the base method description.
`protected void`	`onStopLoading()` Please refer to the base method description.
`protected void`	`onSuccess(BaseResponse<R,E,D> baseResponse)` Callback which is called after successful data loading.
`BaseLoader<C,R,E,D>`	`setCallback(C callback)` Sets callback component.
`BaseLoader<C,R,E,D>`	`setProgress(BaseLoader.ProgressWrapper progress)` Sets component to display progress.
`BaseLoader<C,R,E,D>`	`setTimeout(int timeout)` Sets timeout (in seconds).
`String`	`toString()` Please refer to the base method description.

Methods inherited from class android.content.Loader
abandon, cancelLoad, commitContentChanged, dataToString, deliverCancellation, dump, forceLoad, getContext, getId, isAbandoned, isReset, isStarted, onAbandon, onCancelLoad, onContentChanged, registerListener, registerOnLoadCanceledListener, reset, rollbackContentChanged, startLoading, stopLoading, takeContentChanged, unregisterListener, unregisterOnLoadCanceledListener

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

- Constructor Detail
  - BaseLoader
```
public BaseLoader(@NonNull
          Context context)
```
    Initialises a newly created BaseLoader object.
    
    Parameters:
    context - The context
  - BaseLoader
```
public BaseLoader(@NonNull
          Context context,
          String description)
```
    Initialises a newly created BaseLoader object.
    
    Parameters:
    context - The context
    description - The data description (for GUI)
  - BaseLoader
```
public BaseLoader(@NonNull
          Context context,
          String description,
          String logDescription)
```
    Initialises a newly created BaseLoader object.
    
    Parameters:
    context - The context
    description - The data description (for GUI)
    logDescription - The data description (for logging)
  - BaseLoader
```
public BaseLoader(@NonNull
          Context context,
          @StringRes
          int resId)
```
    Initialises a newly created BaseLoader object.
    
    Parameters:
    context - The context
    resId - The resource ID of the data description (for GUI)
  - BaseLoader
```
public BaseLoader(@NonNull
          Context context,
          @StringRes
          int resId,
          String logDescription)
```
    Initialises a newly created BaseLoader object.
    
    Parameters:
    context - The context
    resId - The resource ID of the data description (for GUI)
    logDescription - The data description (for logging)
- Method Detail
  - setProgress
```
public BaseLoader<C,R,E,D> setProgress(BaseLoader.ProgressWrapper progress)
```
    Sets component to display progress.
    
    Parameters:
    progress - The progress component
    
    Returns:
    This BaseLoader object
  - setCallback
```
public BaseLoader<C,R,E,D> setCallback(C callback)
```
    Sets callback component. For example:
```
 setCallback(new Callback<D>() {

     @Override
     public void success(D result, Response response) {
         loader.callbackHelper(true, new BaseResponse<...>(...));
     }

     @Override
     public void failure(RetrofitError error) {
         loader.callbackHelper(false, new BaseResponse<...>(...));
     }
 });
 
```
    Parameters:
    callback - The callback component
    
    Returns:
    This BaseLoader object
    See Also:
    callbackHelper, BaseResponse
  - setTimeout
```
public BaseLoader<C,R,E,D> setTimeout(int timeout)
```
    Sets timeout (in seconds).
    
    Parameters:
    timeout - The timeout
    
    Returns:
    This BaseLoader object
  - makeRequest
```
protected void makeRequest()
```
    Starts an asynchronous load.
  - callbackHelper
```
public void callbackHelper(boolean success,
                  @NonNull
                  BaseResponse<R,E,D> baseResponse)
```
    Subject to call from the callback (see setCallback()).
    
    Parameters:
    success - true if data loading completed successfully, false otherwise
    baseResponse - The results of loading
  - onSuccess
```
@MainThread
protected void onSuccess(@NonNull
                        BaseResponse<R,E,D> baseResponse)
```
    Callback which is called after successful data loading.
    
    Parameters:
    baseResponse - The results of loading
  - onFailure
```
@MainThread
protected void onFailure(@NonNull
                        BaseResponse<R,E,D> baseResponse)
```
    Callback which is called after NOT successful data loading.
    
    Parameters:
    baseResponse - The results of loading
  - deliver
```
protected void deliver(@NonNull
           BaseResponse<R,E,D> baseResponse)
```
    Delivers the results of loading.
    
    Parameters:
    baseResponse - The results
  - makeRequest
```
protected abstract void makeRequest(@NonNull
               C callback)
```
    Starts an asynchronous load.
    
    Parameters:
    callback - The callback
  - destroyLoaders
```
public static void destroyLoaders(LoaderManager loaderManager,
                  Collection<Integer> loaderIds)
```
    Destroys loaders.
    
    Parameters:
    loaderManager - The loader manager
    loaderIds - The list of loaders to destroy
  - destroyLoader
```
public static boolean destroyLoader(LoaderManager loaderManager,
                    int loaderId)
```
    Destroys loader with the given ID.
    
    Parameters:
    loaderManager - The loader manager
    loaderId - The loader ID
    
    Returns:
    true if loader was successfully destroyed, false otherwise
  - toString
```
public String toString()
```
    Please refer to the base method description.
    
    Overrides:
    
    toString in class Loader<BaseResponse<R,E,D>>
  - deliverResult
```
@MainThread
public void deliverResult(BaseResponse<R,E,D> data)
```
    Please refer to the base method description.
    
    Overrides:
    
    deliverResult in class Loader<BaseResponse<R,E,D>>
  - onStartLoading
```
protected void onStartLoading()
```
    Please refer to the base method description.
    
    Overrides:
    
    onStartLoading in class Loader<BaseResponse<R,E,D>>
  - onStopLoading
```
@MainThread
protected void onStopLoading()
```
    Please refer to the base method description.
    
    Overrides:
    
    onStopLoading in class Loader<BaseResponse<R,E,D>>
  - onForceLoad
```
@MainThread
protected void onForceLoad()
```
    Please refer to the base method description.
    
    Overrides:
    
    onForceLoad in class Loader<BaseResponse<R,E,D>>
  - onReset
```
@MainThread
protected void onReset()
```
    Please refer to the base method description.
    
    Overrides:
    
    onReset in class Loader<BaseResponse<R,E,D>>
  - getCoreLoad
```
public static BaseResponseLoaderWrapper.CoreLoad getCoreLoad(Fragment fragment)
```
    Returns the CoreLoad component for the given fragment.
    
    Parameters:
    fragment - The fragment
    
    Returns:
    The CoreLoad
  - getCoreLoad
```
public static BaseResponseLoaderWrapper.CoreLoad getCoreLoad(Activity activity)
```
    Returns the CoreLoad component for the given activity.
    
    Parameters:
    activity - The activity
    
    Returns:
    The CoreLoad

Copyright © 2015-2017 akha, a.k.a. Alexander Kharitonov

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Class BaseLoader<C,R,E,D>

Nested Class Summary

Nested classes/interfaces inherited from class android.content.Loader

Constructor Summary

Method Summary

Methods inherited from class android.content.Loader

Methods inherited from class java.lang.Object

Constructor Detail

BaseLoader

BaseLoader

BaseLoader

BaseLoader

BaseLoader

Method Detail

setProgress

setCallback

setTimeout

makeRequest

callbackHelper

onSuccess

onFailure

deliver

makeRequest

destroyLoaders

destroyLoader

toString

deliverResult

onStartLoading

onStopLoading

onForceLoad

onReset

getCoreLoad

getCoreLoad