kinugasa.contents.saveData
クラス SaveData

java.lang.Object
  上位を拡張 kinugasa.contents.saveData.SaveData
すべての実装されたインタフェース:
java.io.Serializable, Nameable
直系の既知のサブクラス:
ScoreSaveData

public abstract class SaveData
extends java.lang.Object
implements Nameable, java.io.Serializable

ゲームの途中経過を保存するためのクラスです.
このクラスを拡張して、必要なフィールドを定義してください。

セーブデータの持つメタ情報としては、名前、作成時刻、更新日時があります。
名前と更新日時は自由に使用することができます。名前はNameableのキーとして 使用されます。名前と作成日時は、変更できません。

バージョン:
1.0.0 - 2013/01/13_0:10:27
作成者:
Dra0211
関連項目:
直列化された形式

フィールドの概要
private  long createTime
          セーブデータが作成された日時です.
private  java.util.Date date
          最終更新などを保管するDateです.
private  java.lang.String name
          セーブデータの名前です.
private static long serialVersionUID
           
 
コンストラクタの概要
SaveData()
          新しいセーブデータを作成します.
SaveData(java.lang.String name)
          新しいセーブデータを作成します.
 
メソッドの概要
 long getCreateTime()
          このセーブデータが最初に作成された時刻を取得します.
 java.util.Date getDate()
          このセーブデータの更新日時を取得します.
 java.lang.String getName()
          このインスタンスの一意的な名前を取得します.
static SaveData load(java.io.File file)
          指定されたファイルから、セーブデータを読み込みます.
static java.util.List<SaveData> loadAll(java.io.File dir)
          指定されたパスにあるすべての読み込み可能なファイルをセーブデータとしてロードし、リストとして返します.
 void save(java.io.File file)
          指定されたファイルに、このセーブデータを保存します.
 void setDate(java.util.Date date)
          このセーブデータの更新日時を設定します.
 java.lang.String toString()
           
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

serialVersionUID

private static final long serialVersionUID
関連項目:
定数フィールド値

name

private java.lang.String name
セーブデータの名前です.


createTime

private long createTime
セーブデータが作成された日時です.


date

private java.util.Date date
最終更新などを保管するDateです.

コンストラクタの詳細

SaveData

public SaveData()
新しいセーブデータを作成します. このコンストラクタでは、名前は空の文字列に設定されます。


SaveData

public SaveData(java.lang.String name)
新しいセーブデータを作成します. 作成日時および更新日時は現在の時刻に設定されます。

パラメータ:
name - セーブデータの名前を指定します。一意的である必要があります。
メソッドの詳細

getName

public final java.lang.String getName()
インタフェース Nameable の記述:
このインスタンスの一意的な名前を取得します. 名前はゲームの実行中変更されてはなりません。

定義:
インタフェース Nameable 内の getName
戻り値:
このインスタンスを識別できる一意的な名前を返します。名前はユーザやプレイヤーが指定する可能性があるため 意味のある文字列を推奨します。

getDate

public final java.util.Date getDate()
このセーブデータの更新日時を取得します.

戻り値:
このセーブデータに設定された更新日時を返します。

setDate

public final void setDate(java.util.Date date)
このセーブデータの更新日時を設定します.

パラメータ:
date - このセーブデータに設定する更新日時を送信します。

getCreateTime

public final long getCreateTime()
このセーブデータが最初に作成された時刻を取得します. この値は、通常は一意的です。ただし、この値はミリ秒単位なので、 短時間に複数のセーブデータを生成した場合は、重複する可能性があります。

戻り値:
このセーブデータが作成された時刻を返します。

save

public final void save(java.io.File file)
                throws ContentsFileNotFoundException,
                       ContentsIOException
指定されたファイルに、このセーブデータを保存します. 保存したファイルはContentsIOを使用して復元できます。

パラメータ:
file - 発行するファイルを指定します。上書きの確認は行われません。
例外:
ContentsFileNotFoundException - ファイルパスが不正な場合に投げられます。
ContentsIOException - コンテンツのIOに失敗した場合に投げられます。

load

public static SaveData load(java.io.File file)
                     throws ContentsFileNotFoundException,
                            ContentsIOException
指定されたファイルから、セーブデータを読み込みます. このメソッドは、ContentsIOを使用したロードと同じ動作をします。

パラメータ:
file - 読み込むファイルを指定します。
戻り値:
指定されたファイルから復元されたセーブデータを返します。
例外:
ContentsFileNotFoundException - ファイルパスが不正な場合に投げられます。
ContentsIOException - コンテンツのIOに失敗した場合に投げられます。

loadAll

public static java.util.List<SaveData> loadAll(java.io.File dir)
                                        throws ContentsFileNotFoundException,
                                               ContentsIOException,
                                               java.lang.IllegalArgumentException
指定されたパスにあるすべての読み込み可能なファイルをセーブデータとしてロードし、リストとして返します.

パラメータ:
dir - 読み込むディレクトリのルートとなるディレクトリのパスを指定します。入れ子になったディレクトリは 再帰的に処理されます。
戻り値:
指定されたディレクトリ以下にある、セーブデータの発行済みデータを復元し、リストとして返します。
例外:
ContentsFileNotFoundException - ファイルパスが不正な場合に投げられます。
ContentsIOException - コンテンツのIOに失敗した場合に投げられます。
java.lang.IllegalArgumentException - dirがディレクトリでない場合に投げられます。

toString

public java.lang.String toString()
オーバーライド:
クラス java.lang.Object 内の toString