icepick

Android Bundle save and restore instance state made easy

License

License

GroupId

GroupId

com.github.frankiesardo
ArtifactId

ArtifactId

icepick
Last Version

Last Version

2.3.6
Release Date

Release Date

Type

Type

jar
Description

Description

icepick
Android Bundle save and restore instance state made easy
Project URL

Project URL

https://github.com/frankiesardo/icepick
Source Code Management

Source Code Management

https://github.com/frankiesardo/icepick

Download icepick

How to add to project

<!-- https://jarcasting.com/artifacts/com.github.frankiesardo/icepick/ -->
<dependency>
    <groupId>com.github.frankiesardo</groupId>
    <artifactId>icepick</artifactId>
    <version>2.3.6</version>
</dependency>
// https://jarcasting.com/artifacts/com.github.frankiesardo/icepick/
implementation 'com.github.frankiesardo:icepick:2.3.6'
// https://jarcasting.com/artifacts/com.github.frankiesardo/icepick/
implementation ("com.github.frankiesardo:icepick:2.3.6")
'com.github.frankiesardo:icepick:jar:2.3.6'
<dependency org="com.github.frankiesardo" name="icepick" rev="2.3.6">
  <artifact name="icepick" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.github.frankiesardo', module='icepick', version='2.3.6')
)
libraryDependencies += "com.github.frankiesardo" % "icepick" % "2.3.6"
[com.github.frankiesardo/icepick "2.3.6"]

Dependencies

provided (1)

Group / Artifact Type Version
com.google.android : android jar 4.1.1.4

test (4)

Group / Artifact Type Version
junit : junit jar 4.11
org.powermock : powermock-api-mockito jar 1.5
org.powermock : powermock-module-junit4 jar 1.5
org.mockito : mockito-core jar 1.9.5

Project Modules

There are no modules declared in this project.

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.

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)

Icepick can also generate the instance state code for custom Views:

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.

class MyFragment {
  @State(MyCustomBundler.class) MyCustomType myCustomType;
}

class MyCustomBundler implements Bundler<MyCustomType> {
  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.* <fields>;
}
-keepnames class * { @icepick.State *;}

Download

Icepick needs two libraries: icepick and icepick-processor.

Clojars Project

Clojars Project

Gradle:

repositories {
  maven {url "https://clojars.org/repo/"}
}
dependencies {
  compile 'frankiesardo:icepick:{{latest-version}}'
  provided 'frankiesardo:icepick-processor:{{latest-version}}'
}

Maven:

<repositories>
  <repository>
    <id>clojars</id>
    <url>https://clojars.org/repo/</url>
    <snapshots>
      <enabled>true</enabled>
    </snapshots>
    <releases>
      <enabled>true</enabled>
    </releases>
  </repository>
</repositories>
<dependencies>
  <dependency>
    <groupId>frankiesardo</groupId>
    <artifactId>icepick</artifactId>
    <version>{{latest-version}}</version>
  </dependency>
  <dependency>
    <groupId>frankiesardo</groupId>
    <artifactId>icepick-processor</artifactId>
    <version>{{latest-version}}</version>
    <optional>true</optional>
  </dependency>
</dependencies>

Versions

Version
2.3.6
2.3.5
2.3.4
2.3.3
2.3.2
2.3.1
2.3
2.2.1
2.2
2.1
2.0
1.2
1.1
1.0