PropertiesUtil - JavaDoc

クラス情報

パッケージ: com.onepg.util

クラス名: PropertiesUtil

説明

設定ファイルユーティリティクラス.

設定ファイル拡張子は .properties とする。（それ以外は無視される）
設定ファイル格納ディレクトリ（以下、設定ディレクトリ）はアプリケーション配備ディレクトリ直下の config ディレクトリとし、アプリケーション配備ディレクトリから相対的に固定とする。
［例］application/lib/program.jar の場合、application/config/ 配下となる。
アプリケーション配備ディレクトリの詳細は #APPLICATION_DIR_PATH 参照。
通常、設定ディレクトリのパスは上記のとおりだが、パスを変更したい場合は config/config.properties に設定キー CONFIG_DIR でパス指定する。
設定ファイルの文字セットは UTF-8 を前提とする。
設定ファイルの内容は設定キーと設定値を列挙するカタチとし下記例のとおり。
KEY1=VAL1
KEY2=VAL2
KEY3=VAL3
設定ファイル名は自由だが下記ファイル名はフレームワーク部品専用とし使用不可とする。
web.properties
bat.properties
db.properties
config.properties
設定ファイルの数は自由だが設定ファイルを跨いで設定キーは一意にする必要がある。（フレームワーク部品用設定ファイルとは重複しても問題ない）
設定値が ${ と } で囲われている場合は囲われている環境変数の値と置換する。（部分置換も可能）
ただし、環境変数に存在しない場合はシステムエラーが発生する。
［例 Windows環境］${USERNAME} は現在のユーザー名に置換される。
［例 Linux環境］${USER} は現在のユーザー名に置換される。
設定値内の $ApplicationDirPath はアプリケーション配備ディレクトリパスと置換する。（部分置換も可能）
アプリケーション配備ディレクトリの詳細は #APPLICATION_DIR_PATH 参照。
設定値内の $TemporaryDirPath は OS の一時ディレクトリパスと置換する。（部分置換も可能）
具体的には Java の java.io.tmpdir システムプロパティのパスを置換する。
<ConvertAbsolutePath> 始まりの設定値は絶対パス変換する。
設定ファイル内で # 始まりの行はコメントとして無視される。（Properties#load(java.io.InputStream) の仕様）
本クラスでは設定ファイルへの書込みは扱わない。

列挙型一覧

FwPropertiesName

public enum FwPropertiesName

フレームワーク専用設定ファイル名.

定数

WEB
BAT
DB
LOG
PROPDIR

定数・変数一覧

LOCALHOST_NAME

public String LOCALHOST_NAME

ローカルホスト名.

APPLICATION_DIR_PATH

public String APPLICATION_DIR_PATH

アプリケーション配備ディレクトリパス.

アプリケーション配備ディレクトリとは下記のいずれかのディレクトリを指す。
- Javaクラスファイル配備ルートディレクトリ（com や jp など）の２つ上のディレクトリ
  ［例］appdeploy/classes/com/onepg/Program.class の場合、appdeploy
- Jarファイル配備ディレクトリの２つ上のディレクトリ
  ［例］appdeploy/lib/program.jar の場合、appdeploy

MODULE_PROP_MAP

public IoItems MODULE_PROP_MAP

機能設定.

設定ディレクトリ配下の設定ファイルの設定値をマップで返す。
フレームワーク専用設定ファイルは除外する。
設定ファイルの数は自由だが設定ファイルを跨いで設定キーは一意にする必要がある。

［例］final String value = PropertiesUtil.MODULE_PROP_MAP.getString("module.unique.key");

メソッド一覧

getFrameworkProps

public IoItems getFrameworkProps(FwPropertiesName propFileName)

フレームワーク設定取得.

パラメータ

名前	型	説明
`propFileName`	`FwPropertiesName`	設定ファイル名

戻り値

IoItems - 設定値マップ

isWindowsOs

public boolean isWindowsOs()

MS-WindowsOS判断.

戻り値

boolean - WindowsOSの場合は true