to.tetramorph.util
クラス FileTools

java.lang.Object
  上位を拡張 to.tetramorph.util.FileTools

public class FileTools
extends Object

設定プロパティファイルなどのリソースを取得して返すメソッド群からなる。 2011-07-28 ロガーを使うように修正。


メソッドの概要
static boolean loadProperties(Properties properties, File file)
          fileで指定されたプロパティファイルからデータをpropertiesにロードする。
static boolean loadProperties(Properties properties, InputStream inputStream)
          inputStreamからXML形式のプロパティファイルをロードする。
static StringBuilder loadText(InputStream stream, String charset)
          入力ストリームからテキストを読みこむ。
static boolean saveProperties(Properties properties, File file, String comment)
          指定されたpropertiesの内容を指定されたfileに、XMLフォーマット(UTF-8)で セーブする。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

メソッドの詳細

loadProperties

public static boolean loadProperties(Properties properties,
                                     File file)
fileで指定されたプロパティファイルからデータをpropertiesにロードする。 成功したときはtrueを返し、失敗(ファイルが存在しなかったり、フォーマットが 異常だった場合)したときはfalseを返す。properitesにnullを渡すと戻り値はfalse。

パラメータ:
properties - データをロードしたいProperitesオブジェクト
file - ロードするファイルオブジェクト。
戻り値:
ロードに成功すればtrue,失敗するとfalse。

loadProperties

public static boolean loadProperties(Properties properties,
                                     InputStream inputStream)
inputStreamからXML形式のプロパティファイルをロードする。 ストリームから取得されたるプロパティはUTF-8で記述されていること。

パラメータ:
properties - このプロパティにデータがロードされる。
inputStream - プロパティの入力ストリーム
戻り値:
ロードに成功したときはtrue,失敗するとfalse。

saveProperties

public static boolean saveProperties(Properties properties,
                                     File file,
                                     String comment)
指定されたpropertiesの内容を指定されたfileに、XMLフォーマット(UTF-8)で セーブする。書き込みに成功した場合はtrueを返す。

パラメータ:
properties - セーブしたいProperitesオブジェクト
file - 書き出したいファイルオブジェクト。 ファイル名は"*.properties"とするのが標準的。
comment - プロパティファイル内に書かれる一行コメント。適当なコメント 文字列であればなんでもよい。
戻り値:
セーブに成功したときはtrue。失敗したらfalse。

loadText

public static StringBuilder loadText(InputStream stream,
                                     String charset)
入力ストリームからテキストを読みこむ。 主にjar書庫のリソースからファイルを読み出すのに使用する。 処理終了後、streamはクローズされる。
 InputStream is = Hoge.class.getResourceAsStream("/resources/hoge.txt");
 StringBuilder sb = FileTools.loadText(is,"sjis");
 

パラメータ:
stream - 入力ストリーム
charset - 文字コードセット
戻り値:
文字列が格納されたStringBuilder。IOExceptionで読みこみに失敗 したときはnullを返す。