Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kimkevin/CachePot
Android Data Object Cache Management
https://github.com/kimkevin/CachePot
activity android data-cache data-store fragment
Last synced: 5 days ago
JSON representation
Android Data Object Cache Management
- Host: GitHub
- URL: https://github.com/kimkevin/CachePot
- Owner: kimkevin
- Created: 2015-09-21T15:45:22.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2019-03-13T15:30:12.000Z (over 5 years ago)
- Last Synced: 2024-07-24T05:44:40.579Z (3 months ago)
- Topics: activity, android, data-cache, data-store, fragment
- Language: Java
- Homepage:
- Size: 16.7 MB
- Stars: 40
- Watchers: 5
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-android - CachePot
README
CachePot - Android Simple Data Cache
=====
[](https://travis-ci.org/kimkevin/CachePot)
[ ](https://bintray.com/kimkevin/maven/com.github.kimkevin%3Acachepot/_latestVersion)
[](https://android-arsenal.com/api?level=14)
CachePot is a simple open source for data cache management and passing data object between Fragments(Activities) without Pacelable and Serializable.
> WARNING: It would be inappropriate to pass data both ways between different android applications, it's a better way to use `Intent` properly.
# Download
Gradle:
```bash
repositories {
jcenter()
}
dependencies {
compile 'com.github.kimkevin:cachepot:1.2.0’
}
```
Maven:
```bash
com.github.kimkevin
cachepot
1.2.0
```
# Usage
It works anywhere. there're examples as below
* Between `Activity` and `Activity`
* Between `Activity` and `Fragment`
* Between `Fragment` and `Fragment`
* From `PagerAdapter` to individual `Fragment`
## 1. Single Type, Single Data
Push your data object to `CachePot` instance in your `Activity` or `Fragment`.
> public void push(Object data)
```java
KoreanFood foodItem = new KoreanFood(1, "Kimchi", "Traditional fermented Korean side dish made of vegetables")
CachePot.getInstance().push(foodItem);
// open your activity or fragment
```
Pop your data object from `CachePot` after view changes
> public Object pop(Class classType)
```java
public class MainFragment extends Fragment{
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
KoreanFood foodItem = CachePot.getInstance().pop(KoreanFood.class);
}
```
#### In case of Collection or Map
> Push
```java
List foodItems = new ArrayList<>();
foodItems.add(new KoreanFood(1, "Kimchi", "Traditional fermented Korean side dish made of vegetables"));
foodItems.add(new KoreanFood(2, "Kkakdugi", "A variety of kimchi in Korean cuisine"));
CachePot.getInstance().push(foodItems);
// open your activity or fragment
```
> Pop
```java
List foodItems = CachePot.getInstance().pop(ArrayList.class);
```
## 2. Single Type, Multiple Data
How to pass Object(Model) Asynchronously when using ViewPager
First push your data object with `position` or `id` to `CachePot` instance in `FragmentStatePagerAdapter`(or `FragmentPagerAdapter`)
> public void push(long id, Object data)
```java
private class PagerAdapter extends FragmentStatePagerAdapter {
...
public Fragment getItem(int position) {
KoreanFood foodItem = foodItems.get(position);
CachePot.getInstance().push(position, foodItem);
// or
CachePot.getInstance().push(foodItem.getId(), foodItem);
...
}
}
```
> public Object pop(long id)
```java
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
...
if (getArguments() != null) {
final int position = getArguments().getInt(ARG_POSITION);
foodItem = CachePot.getInstance().pop(position);
// or
foodItem = CachePot.getInstance().pop(id);
}
}
```
**If more complecated views, use TAG**
> public void push(String tag, Object data)
> public void push(String tag, long id, Object data)
```java
private class PagerAdapter extends FragmentStatePagerAdapter {
...
public Fragment getItem(int position) {
KoreanFood foodItem = foodItems.get(position);
CachePot.getInstance().push(TAG, position, foodItem);
// or
CachePot.getInstance().push(TAG, foodItem.getId(), foodItem);
...
}
}
```
> public Object pop(String tag)
> public Object pop(String tag, long id)
```java
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
...
if (getArguments() != null) {
final int position = getArguments().getInt(ARG_POSITION);
foodItem = CachePot.getInstance().pop(TAG, position);
// or
foodItem = CachePot.getInstance().pop(TAG, id);
}
}
```
# Contributing
All contributions are welcome. Open a [Pull Requests](https://github.com/kimkevin/CachePot/pulls) or refer to
the [Issues](https://github.com/kimkevin/CachePot/issues) section.
# License
MIT
Copyright (c) 2016-present, “KimKevin” Yongjun Kim