Android Parcelable を使ってクラスのメンバを一時保存

さて、前回のエントリで、Bundle で状態を保存する方法を
書きました。
Android　Bundle で状態を保存

ここでは、Bundle の Method （例えば putString と getString）
を使ってパラメータを保存する方法を紹介しました。

しかーし、ここで問題が発生

「独自にデータクラスを用意していて、このクラスのメンバごと保存したいんだけど…」

さぁ、この場合どうする？

ここで登場するのが Parcelable さんです。

Parcelable はリファレンス
http://developer.android.com/intl/ja/reference/android/os/Parcelable.html
に書いてあるように、Parcel にデータを書き／読みするためのインタフェースです。

"Interface for classes whose instances can be written to and restored from a Parcel. Classes implementing the Parcelable interface must also have a static field called CREATOR, which is an object implementing the Parcelable.Creator interface. "

Parcelable インタフェースを実装したクラスは、Parcelable.Creator インタフェースを実装するオブジェクトである CREATOR と呼ばれる静的フィールドを持たなくてはなりません。

そして、ご丁寧に Parcelable インタフェースを実装するクラスの例が載ってます。

view plainprint?

1. public class MyParcelable implements Parcelable {  
2.     private int mData;  
3.   
4.     public int describeContents() {  
5.         return 0;  
6.     }  
7.   
8.     public void writeToParcel(Parcel out, int flags) {  
9.         out.writeInt(mData);  
10.     }  
11.   
12.     public static final Parcelable.Creator<MyParcelable> CREATOR  
13.             = new Parcelable.Creator<MyParcelable>() {  
14.         public MyParcelable createFromParcel(Parcel in) {  
15.             return new MyParcelable(in);  
16.         }  
17.   
18.         public MyParcelable[] newArray(int size) {  
19.             return new MyParcelable[size];  
20.         }  
21.     };  
22.       
23.     private MyParcelable(Parcel in) {  
24.         mData = in.readInt();  
25.     }  
26. }  

 public class MyParcelable implements Parcelable {
     private int mData;

     public int describeContents() {
         return 0;
     }

     public void writeToParcel(Parcel out, int flags) {
         out.writeInt(mData);
     }

     public static final Parcelable.Creator<MyParcelable> CREATOR
             = new Parcelable.Creator<MyParcelable>() {
         public MyParcelable createFromParcel(Parcel in) {
             return new MyParcelable(in);
         }

         public MyParcelable[] newArray(int size) {
             return new MyParcelable[size];
         }
     };
     
     private MyParcelable(Parcel in) {
         mData = in.readInt();
     }
 }

ここでは、Parcel に保存するパラメータとして、mData が1つですが、

例えば、名前、年齢、アドレスをメンバに持つ
クラス（ContactParcelable）を作るとこんな感じになります。

view plainprint?

1. public class ContactParcelable implements Parcelable {  
2.     private String name;  
3.     private int age;  
4.     private String address;  
5.   
6.     public int describeContents() {  
7.         return 0;  
8.     }  
9.   
10.     public void writeToParcel(Parcel out, int flags) {  
11.         out.writeString(name);  
12.         out.writeInt(age);  
13.         out.writeString(address);  
14.     }  
15.   
16.     public static final Parcelable.Creator<ContactParcelable> CREATOR  
17.             = new Parcelable.Creator<ContactParcelable>() {  
18.         public ContactParcelable createFromParcel(Parcel in) {  
19.             return new ContactParcelable(in);  
20.         }  
21.   
22.         public ContactParcelable[] newArray(int size) {  
23.             return new ContactParcelable[size];  
24.         }  
25.     };  
26.        
27.      private ContactParcelable(Parcel in) {  
28.          name = in.readString();  
29.          age = in.readInt();  
30.          address = in.readString();  
31.      }  
32.   
33.      public ContactParcelable(String name, int age, String address) {  
34.          this.name = name;  
35.          this.age  = age;  
36.          this.address = address;  
37.      }  
38.  }  

public class ContactParcelable implements Parcelable {
    private String name;
    private int age;
    private String address;

    public int describeContents() {
        return 0;
    }

    public void writeToParcel(Parcel out, int flags) {
        out.writeString(name);
        out.writeInt(age);
        out.writeString(address);
    }

    public static final Parcelable.Creator<ContactParcelable> CREATOR
            = new Parcelable.Creator<ContactParcelable>() {
        public ContactParcelable createFromParcel(Parcel in) {
            return new ContactParcelable(in);
        }

        public ContactParcelable[] newArray(int size) {
            return new ContactParcelable[size];
        }
    };
     
     private ContactParcelable(Parcel in) {
         name = in.readString();
         age = in.readInt();
         address = in.readString();
     }

     public ContactParcelable(String name, int age, String address) {
         this.name = name;
         this.age  = age;
         this.address = address;
     }
 }

writeToParcel(Parcel out, int flags)
で書き込む順番と
ContactParcelable(Parcel in)
で読み出す順番は同じにしなければなりません。

で、このクラスを
onSaveInstanceState(Bundle) で保存し、
onRestoreInstanceState(Bundle)
で読み出すには、こんな感じでOK

view plainprint?

1. ContactParcelable contactParcelable;  
2.   
3. @Override  
4. public void onCreate(Bundle savedInstanceState) {  
5.     super.onCreate(savedInstanceState);  
6.   
7.     contactParcelable = new ContactParcelable("あんどろいど", 2, "android@gmail.com");  
8. }  
9.   
10. @Override    
11. protected void onSaveInstanceState(Bundle outState) {    
12.     super.onSaveInstanceState(outState);    
13.     /* ここで状態を保存 */    
14.     outState.putParcelable("contact", contactParcelable);  
15. }    
16.   
17. @Override    
18. protected void onRestoreInstanceState(Bundle savedInstanceState) {    
19.    super.onRestoreInstanceState(savedInstanceState);    
20.    /* ここで保存した状態を読み出して設定 */    
21.    contactParcelable = savedInstanceState.getParcelable("contact");  
22. }    

ContactParcelable contactParcelable;

@Override
public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    contactParcelable = new ContactParcelable("あんどろいど", 2, "android@gmail.com");
}

@Override  
protected void onSaveInstanceState(Bundle outState) {  
    super.onSaveInstanceState(outState);  
    /* ここで状態を保存 */  
    outState.putParcelable("contact", contactParcelable);
}  

@Override  
protected void onRestoreInstanceState(Bundle savedInstanceState) {  
   super.onRestoreInstanceState(savedInstanceState);  
   /* ここで保存した状態を読み出して設定 */  
   contactParcelable = savedInstanceState.getParcelable("contact");
}  

さらにさらに、
もし、メンバがデータクラスのリストだった場合はどうなるか
この場合も Parcelable を実装します。

ContactParcelable のリストをメンバに持つ AllContactParcelable
を一時保存する場合

view plainprint?

1. public class AllContactParcelable implements Parcelable {  
2.   
3.     private ArrayList<ContactParcelable> contactList;  
4.   
5.     public int describeContents() {  
6.         return 0;  
7.     }  
8.   
9.     public void writeToParcel(Parcel out, int flags) {  
10.         out.writeTypedList(contactList);  
11.     }  
12.   
13.     public static final Parcelable.Creator<AllContactParcelable> CREATOR  
14.             = new Parcelable.Creator<AllContactParcelable>() {  
15.         public AllContactParcelable createFromParcel(Parcel in) {  
16.             return new AllContactParcelable(in);  
17.         }  
18.   
19.         public AllContactParcelable[] newArray(int size) {  
20.             return new AllContactParcelable[size];  
21.         }  
22.     };  
23.        
24.      private AllContactParcelable(Parcel in) {  
25.          contactList = in.createTypedArrayList(ContactParcelable.CREATOR);  
26.      }  
27.   
28.      public AllContactParcelable(ArrayList<ContactParcelable> contactList) {  
29.          this.contactList = contactList;  
30.      }  
31.  }  

public class AllContactParcelable implements Parcelable {

    private ArrayList<ContactParcelable> contactList;

    public int describeContents() {
        return 0;
    }

    public void writeToParcel(Parcel out, int flags) {
        out.writeTypedList(contactList);
    }

    public static final Parcelable.Creator<AllContactParcelable> CREATOR
            = new Parcelable.Creator<AllContactParcelable>() {
        public AllContactParcelable createFromParcel(Parcel in) {
            return new AllContactParcelable(in);
        }

        public AllContactParcelable[] newArray(int size) {
            return new AllContactParcelable[size];
        }
    };
     
     private AllContactParcelable(Parcel in) {
         contactList = in.createTypedArrayList(ContactParcelable.CREATOR);
     }

     public AllContactParcelable(ArrayList<ContactParcelable> contactList) {
         this.contactList = contactList;
     }
 }

out.writeTypedList(contactList);
で書き込みし、
contactList = in.createTypedArrayList(ContactParcelable.CREATOR);
で読み出すのがポイント

onSaveInstanceState(Bundle)
と
onRestoreInstanceState(Bundle)
での実装は同じ



参考ページ
・[Android] android.os.Parcelable / Parcel
adakodaさんありがとうございます！

・http://developer.android.com/intl/ja/reference/android/os/Bundle.html
・http://developer.android.com/intl/ja/reference/android/os/Bundle.html#putParcelable%28java.lang.String,%20android.os.Parcelable%29
・http://developer.android.com/intl/ja/reference/android/os/Bundle.html#getParcelable%28java.lang.String%29