Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/frankiesardo/icepick
Android Instance State made easy
https://github.com/frankiesardo/icepick
Last synced: 3 days ago
JSON representation
Android Instance State made easy
- Host: GitHub
- URL: https://github.com/frankiesardo/icepick
- Owner: frankiesardo
- License: epl-1.0
- Created: 2013-07-13T16:43:09.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2021-05-26T07:01:41.000Z (over 3 years ago)
- Last Synced: 2025-01-15T22:13:57.224Z (10 days ago)
- Language: Clojure
- Homepage:
- Size: 923 KB
- Stars: 3,746
- Watchers: 91
- Forks: 208
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- android-awesome-libraries - icepick - Android Instance State made easy (Uncategorized / Uncategorized)
README
Icepick
============
Icepick is an Android library that eliminates the boilerplate of saving and restoring instance state.
It uses annotation processing to generate code that does bundle manipulation and key generation, so that you don't have to write it yourself.
```java
class ExampleActivity extends Activity {
@State String username; // This will be automatically saved and restored
@Override public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
Icepick.restoreInstanceState(this, savedInstanceState);
}
@Override public void onSaveInstanceState(Bundle outState) {
super.onSaveInstanceState(outState);
Icepick.saveInstanceState(this, outState);
}
// You can put the calls to Icepick into a BaseActivity
// All Activities extending BaseActivity automatically have state saved/restored
}
```
It works for `Activities`, `Fragments` or any object that needs to serialize its state on a `Bundle` (e.g. mortar's [ViewPresenters](https://github.com/square/mortar/blob/master/mortar/src/main/java/mortar/ViewPresenter.java))
Icepick can also generate the instance state code for custom Views:
```java
class CustomView extends View {
@State int selectedPosition; // This will be automatically saved and restored
@Override public Parcelable onSaveInstanceState() {
return Icepick.saveInstanceState(this, super.onSaveInstanceState());
}
@Override public void onRestoreInstanceState(Parcelable state) {
super.onRestoreInstanceState(Icepick.restoreInstanceState(this, state));
}
// You can put the calls to Icepick into a BaseCustomView and inherit from it
// All Views extending this CustomView automatically have state saved/restored
}
```
Custom Bundler
--------
From version `3.2.0` you can supply a class parameter to the `State` annotation.
This class should implement the `Bundler` interface and you can use it to provide custom serialisation and deserialisation for your types.
```java
class MyFragment {
@State(MyCustomBundler.class) MyCustomType myCustomType;
}
class MyCustomBundler implements Bundler {
void put(String key, MyCustomType value, Bundle bundle) {
...
}
MyCustomType get(String key, Bundle bundle) {
...
}
}
```
This is useful if you want to use `icepick` in conjunction with `Parceler`.
Proguard
--------
If Proguard is enabled make sure you add these rules to your configuration:
```
-dontwarn icepick.**
-keep class icepick.** { *; }
-keep class **$$Icepick { *; }
-keepclasseswithmembernames class * {
@icepick.* ;
}
-keepnames class * { @icepick.State *;}
```
Download
--------
Icepick needs two libraries: `icepick` and `icepick-processor`.
[](http://clojars.org/frankiesardo/icepick)
[](http://clojars.org/frankiesardo/icepick-processor)
Gradle:
```groovy
repositories {
maven {url "https://clojars.org/repo/"}
}
dependencies {
compile 'frankiesardo:icepick:{{latest-version}}'
provided 'frankiesardo:icepick-processor:{{latest-version}}'
}
```
Maven:
```xml
clojars
https://clojars.org/repo/
true
true
frankiesardo
icepick
{{latest-version}}
frankiesardo
icepick-processor
{{latest-version}}
true
```