BaseResponseLoaderWrapper (Yakhont 0.9.19 API)

java.lang.Object
- akha.yakhont.loader.wrapper.BaseLoaderWrapper<BaseResponse<R,E,D>>
- - akha.yakhont.loader.wrapper.BaseResponseLoaderWrapper<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 to load

All Implemented Interfaces:

LoaderManager.LoaderCallbacks<BaseResponse<R,E,D>>

Direct Known Subclasses:

BaseResponseLoaderWrapper.BaseResponseLoaderExtendedWrapper
```
public class BaseResponseLoaderWrapper<C,R,E,D>
extends BaseLoaderWrapper<BaseResponse<R,E,D>>
```
Extends the BaseLoaderWrapper class to provide CacheLoader support. Most implementations should not use BaseResponseLoaderWrapper directly, but instead utilise RetrofitLoaderWrapper or RetrofitLoaderWrapper.RetrofitLoaderBuilder.

See Also:
CacheLoader, BaseResponseLoaderWrapper.CoreLoad

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`BaseResponseLoaderWrapper.BaseResponseLoaderBuilder<C,R,E,D>` Builder class for `BaseResponseLoaderWrapper` objects.
`static class`	`BaseResponseLoaderWrapper.BaseResponseLoaderExtendedBuilder<C,R,E,D,T>` Builder class for `BaseResponseLoaderWrapper` objects.
`static class`	`BaseResponseLoaderWrapper.BaseResponseLoaderExtendedWrapper<C,R,E,D>` Extends the `BaseResponseLoaderWrapper` class.
`static interface`	`BaseResponseLoaderWrapper.CoreLoad` The `CoreLoad` component is responsible for data loading.

Nested classes/interfaces inherited from class akha.yakhont.loader.wrapper.BaseLoaderWrapper
BaseLoaderWrapper.LoaderBuilder<D>, BaseLoaderWrapper.LoaderFactory<D>, BaseLoaderWrapper.SwipeRefreshWrapper

Constructor Summary

Constructors
Constructor and Description
`BaseResponseLoaderWrapper(Context context, Fragment fragment, Integer loaderId, Core.Requester<C> requester, String tableName, String description, BaseResponse.Converter<D> converter, Core.UriResolver uriResolver)` Initialises a newly created `BaseResponseLoaderWrapper` object.

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`clearCache(BaseResponseLoaderWrapper.CoreLoad coreLoad)` Clears all cache associated with given `CoreLoad` component.
`BaseLoaderWrapper`	`findLoader(Collection<BaseLoaderWrapper> loaders)` Please refer to the base method description.
`BaseCacheAdapter.CacheAdapter<R,E,D>`	`getAdapter()` Returns the adapter.
`BaseRx.LoaderRx<R,E,D>`	`getRx()` Returns the Rx component.
`String`	`getTableName()` Returns the table name.
`Type`	`getType()` Returns the type of data to load.
`Loader<BaseResponse<R,E,D>>`	`onCreateLoader(int id, Bundle args)` Please refer to the base method description.
`void`	`onLoaderReset(Loader<BaseResponse<R,E,D>> loader)` Please refer to the base method description.
`void`	`onLoadFinished(Loader<BaseResponse<R,E,D>> loader, BaseResponse<R,E,D> data)` Please refer to the base method description.
`BaseResponseLoaderWrapper<C,R,E,D>`	`setAdapter(BaseCacheAdapter.CacheAdapter<R,E,D> adapter)` Sets adapter.
`BaseResponseLoaderWrapper<C,R,E,D>`	`setRx(BaseRx.LoaderRx<R,E,D> rx)` Sets Rx component.

Methods inherited from class akha.yakhont.loader.wrapper.BaseLoaderWrapper
geLoaderCallbacks, geLoaderFactory, generateLoaderId, getFragment, getLoaderId, getResult, isLoaderIdAutoGenerated, isLoading, setLoaderCallbacks, setLoaderFactory, setProgress, setSwipeRefreshWrapper, start, start, startSync, startSync, startSync, toString

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

Constructor Detail

BaseResponseLoaderWrapper

public BaseResponseLoaderWrapper(@NonNull
                         Context context,
                         @NonNull
                         Fragment fragment,
                         Integer loaderId,
                         @NonNull
                         Core.Requester<C> requester,
                         @NonNull
                         String tableName,
                         String description,
                         @NonNull
                         BaseResponse.Converter<D> converter,
                         @NonNull
                         Core.UriResolver uriResolver)

Initialises a newly created BaseResponseLoaderWrapper object.

Parameters:: context - The context; fragment - The fragment; loaderId - The loader ID; requester - The requester; tableName - The name of the table in the database (to cache the loaded data); description - The data description; converter - The converter; uriResolver - The URI resolver

Method Detail
- clearCache
```
public static void clearCache(BaseResponseLoaderWrapper.CoreLoad coreLoad)
```
  Clears all cache associated with given CoreLoad component.
  
  Parameters:
  coreLoad - The CoreLoad component
- getType
```
public Type getType()
```
  Returns the type of data to load.
  
  Returns:
  The data type
- setAdapter
```
public BaseResponseLoaderWrapper<C,R,E,D> setAdapter(BaseCacheAdapter.CacheAdapter<R,E,D> adapter)
```
  Sets adapter.
  
  Parameters:
  adapter - The adapter
  
  Returns:
  This BaseResponseLoaderWrapper object
- setRx
```
public BaseResponseLoaderWrapper<C,R,E,D> setRx(BaseRx.LoaderRx<R,E,D> rx)
```
  Sets Rx component.
  
  Parameters:
  rx - The Rx component
  
  Returns:
  This BaseLoaderWrapper object
- getRx
```
public BaseRx.LoaderRx<R,E,D> getRx()
```
  Returns the Rx component.
  
  Returns:
  The Rx component
- getAdapter
```
public BaseCacheAdapter.CacheAdapter<R,E,D> getAdapter()
```
  Returns the adapter.
  
  Returns:
  The adapter
- getTableName
```
public String getTableName()
```
  Returns the table name.
  
  Returns:
  The table name
- findLoader
```
public BaseLoaderWrapper findLoader(Collection<BaseLoaderWrapper> loaders)
```
  Please refer to the base method description.
  
  Overrides:
  
  findLoader in class BaseLoaderWrapper<BaseResponse<R,E,D>>
  
  Parameters:
  loaders - The loaders collection
  
  Returns:
  The BaseLoaderWrapper object or null (if not found)
- onCreateLoader
```
@CallSuper
public Loader<BaseResponse<R,E,D>> onCreateLoader(int id,
                                                   Bundle args)
```
  Please refer to the base method description.
  
  Specified by:
  
  onCreateLoader in interface LoaderManager.LoaderCallbacks<BaseResponse<R,E,D>>
  
  Overrides:
  
  onCreateLoader in class BaseLoaderWrapper<BaseResponse<R,E,D>>
- onLoadFinished
```
@CallSuper
public void onLoadFinished(Loader<BaseResponse<R,E,D>> loader,
                            BaseResponse<R,E,D> data)
```
  Please refer to the base method description.
  
  Specified by:
  
  onLoadFinished in interface LoaderManager.LoaderCallbacks<BaseResponse<R,E,D>>
  
  Overrides:
  
  onLoadFinished in class BaseLoaderWrapper<BaseResponse<R,E,D>>
- onLoaderReset
```
@CallSuper
public void onLoaderReset(Loader<BaseResponse<R,E,D>> loader)
```
  Please refer to the base method description.
  
  Specified by:
  
  onLoaderReset in interface LoaderManager.LoaderCallbacks<BaseResponse<R,E,D>>
  
  Overrides:
  
  onLoaderReset in class BaseLoaderWrapper<BaseResponse<R,E,D>>

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 BaseResponseLoaderWrapper<C,R,E,D>

Nested Class Summary

Nested classes/interfaces inherited from class akha.yakhont.loader.wrapper.BaseLoaderWrapper

Constructor Summary

Method Summary

Methods inherited from class akha.yakhont.loader.wrapper.BaseLoaderWrapper

Methods inherited from class java.lang.Object

Constructor Detail

BaseResponseLoaderWrapper

Method Detail

clearCache

getType

setAdapter

setRx

getRx

getAdapter

getTableName

findLoader

onCreateLoader

onLoadFinished

onLoaderReset