jinro
クラス JinroSettings

java.lang.Object
  上位を拡張 jinro.JinroSettings

public class JinroSettings
extends Object

ユーザー設定のためのクラス。指定されたpropertiesファイルを設定として読み書きします。 設定データを作成(取得)するには、staticメソッドのgetSettingsを使用します。

JinroSettings.getSettings(String name)
引数には設定ファイルのパスを指定します。パスはjinrose.jarファイルのディレクトリを基準とした相対パスまたは絶対パスで記述して下さい。

導入されたバージョン:
Jinro! Second Edition Ver.0.20

メソッドの概要
 boolean getBoolData(String key)
          指定したデータを真偽値として取得します。
 boolean getBoolData(String key, boolean defaultValue)
          指定したデータを真偽値として取得します。
 double getDoubleData(String key)
          指定したデータをdouble型の数値として取得します。
 double getDoubleData(String key, double defaultValue)
          指定したデータをdouble型の数値として取得します。
 float getFloatData(String key)
          指定したデータをfloat型の数値として取得します。
 float getFloatData(String key, float defaultValue)
          指定したデータをfloat型の数値として取得します。
 int getIntData(String key)
          指定したデータをint型の数値として取得します。
 int getIntData(String key, int defaultValue)
          指定したデータをint型の数値として取得します。
 long getLongData(String key)
          指定したデータをlong型の数値として取得します。
 long getLongData(String key, long defaultValue)
          指定したデータをlong型の数値として取得します。
static JinroSettings getSettings(String name)
          JinroSettingsのインスタンスを取得します。
 String getStringData(String key)
          指定したデータを文字列として取得します。
 String getStringData(String key, String defaultValue)
          指定したデータを文字列として取得します。
 boolean hasData(String key)
          そのキーに対応するデータが保持されているかどうかを取得します。
 void removeCache()
          このインスタンスのキャッシュを削除します。
 void setData(String key, Object value)
          そのキーの値としてデータをセットします。
 void store()
          現在の設定データをファイルに反映します。
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

メソッドの詳細

getSettings

public static JinroSettings getSettings(String name)
JinroSettingsのインスタンスを取得します。インスタンスはキャッシュされ、同じ設定データファイルならば同じインスタンスを返します。

パラメータ:
name - 読み書きする設定データファイル
戻り値:
指定のファイルで初期化したJinroSettingsのインスタンス

hasData

public boolean hasData(String key)
そのキーに対応するデータが保持されているかどうかを取得します。

パラメータ:
key - 保持されているか確かめたいキー
戻り値:
保持されていればtrue、そうでなければfalse

setData

public void setData(String key,
                    Object value)
そのキーの値としてデータをセットします。

パラメータ:
key - セットするデータのキー
value - セットするデータ

store

public void store()
現在の設定データをファイルに反映します。


removeCache

public void removeCache()
このインスタンスのキャッシュを削除します。次に同じ設定データファイルをgetSettingsで取得した場合、新たにインスタンスが生成されます。


getStringData

public String getStringData(String key,
                            String defaultValue)
指定したデータを文字列として取得します。

パラメータ:
key - 対象のキー
defaultValue - 取得できなかった場合のデフォルト値
戻り値:
キーに対応するデータ。取得できなかった場合はdefaultValue

getStringData

public String getStringData(String key)
指定したデータを文字列として取得します。

パラメータ:
key - 対象のキー
戻り値:
キーに対応するデータ。取得できなかった場合は空文字列

getBoolData

public boolean getBoolData(String key,
                           boolean defaultValue)
指定したデータを真偽値として取得します。

パラメータ:
key - 対象のキー
defaultValue - 取得できなかった場合のデフォルト値
戻り値:
キーに対応するデータ。取得できなかった場合はdefaultValue

getBoolData

public boolean getBoolData(String key)
指定したデータを真偽値として取得します。

パラメータ:
key - 対象のキー
戻り値:
キーに対応するデータ。取得できなかった場合はfalse

getIntData

public int getIntData(String key,
                      int defaultValue)
指定したデータをint型の数値として取得します。

パラメータ:
key - 対象のキー
defaultValue - 取得できなかった場合のデフォルト値
戻り値:
キーに対応するデータ。取得できなかった場合はdefaultValue

getIntData

public int getIntData(String key)
指定したデータをint型の数値として取得します。

パラメータ:
key - 対象のキー
戻り値:
キーに対応するデータ。取得できなかった場合は0

getLongData

public long getLongData(String key,
                        long defaultValue)
指定したデータをlong型の数値として取得します。

パラメータ:
key - 対象のキー
defaultValue - 取得できなかった場合のデフォルト値
戻り値:
キーに対応するデータ。取得できなかった場合はdefaultValue

getLongData

public long getLongData(String key)
指定したデータをlong型の数値として取得します。

パラメータ:
key - 対象のキー
戻り値:
キーに対応するデータ。取得できなかった場合は0

getFloatData

public float getFloatData(String key,
                          float defaultValue)
指定したデータをfloat型の数値として取得します。

パラメータ:
key - 対象のキー
defaultValue - 取得できなかった場合のデフォルト値
戻り値:
キーに対応するデータ。取得できなかった場合はdefaultValue

getFloatData

public float getFloatData(String key)
指定したデータをfloat型の数値として取得します。

パラメータ:
key - 対象のキー
戻り値:
キーに対応するデータ。取得できなかった場合は0

getDoubleData

public double getDoubleData(String key,
                            double defaultValue)
指定したデータをdouble型の数値として取得します。

パラメータ:
key - 対象のキー
defaultValue - 取得できなかった場合のデフォルト値
戻り値:
キーに対応するデータ。取得できなかった場合はdefaultValue

getDoubleData

public double getDoubleData(String key)
指定したデータをdouble型の数値として取得します。

パラメータ:
key - 対象のキー
戻り値:
キーに対応するデータ。取得できなかった場合は0