jp.terasoluna.fw.util
クラス PropertyUtil

java.lang.Object
  上位を拡張 jp.terasoluna.fw.util.PropertyUtil

public class PropertyUtil
extends Object

プロパティファイルからプロパティを取得するユーティリティクラス。

デフォルトでは ApplicationResources ファイルを読み込むが、 ApplicationResources ファイルで以下のように指定することにより、 他のプロパティファイルを追加で読み込むこともできる。

ApplicationResources.propertiesの設定書式
   add.property.file.1 = <追加プロパティファイル名1>
   add.property.file.2 = <追加プロパティファイル名2>
   ...
 

また、プロパティファイルを個別に指定した以下の機能がある

  1. 部分キー検索による値取得
  2. 部分キー取得
詳細は、 getPropertyNames() メソッド、 getPropertiesValues() メソッドを参照。


フィールドの概要
static String DEFAULT_PROPERTY_FILE
          デフォルトプロパティファイル名。
 
コンストラクタの概要
PropertyUtil()
           
 
メソッドの概要
static void addPropertyFile(String name)
          指定されたプロパティファイルを追加で読み込む。
static Set<String> getPropertiesValues(Properties localProps, Enumeration<String> propertyNames)
          キー一覧に対し、プロパティより取得した値を取得する。
static Set getPropertiesValues(String propertyName, String keyPrefix)
          プロパティファイル名、部分キー文字列を指定することにより 値セットを取得する。
static String getProperty(String key)
          指定されたキーのプロパティを取得する。
static String getProperty(String key, String defaultValue)
          指定されたキーのプロパティを取得する。
static Enumeration getPropertyNames()
          プロパティのすべてのキーのリストを取得する。
static Enumeration<String> getPropertyNames(Properties localProps, String keyPrefix)
          プロパティを指定し、部分キープリフィックスに合致する キー一覧を取得する。
static Enumeration<String> getPropertyNames(String keyPrefix)
          指定されたプリフィックスから始まるキーのリストを取得する。
static Properties loadProperties(String propertyName)
          指定したプロパティファイル名で、プロパティオブジェクトを取得する。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

DEFAULT_PROPERTY_FILE

public static final String DEFAULT_PROPERTY_FILE
デフォルトプロパティファイル名。

関連項目:
定数フィールド値
コンストラクタの詳細

PropertyUtil

public PropertyUtil()
メソッドの詳細

addPropertyFile

public static void addPropertyFile(String name)
指定されたプロパティファイルを追加で読み込む。

複数回呼び出しても1度しか読み込まれない。 プロパティファイル名の ".properties" は省略できる。

パラメータ:
name - プロパティファイル名

getProperty

public static String getProperty(String key)
指定されたキーのプロパティを取得する。

参照値が "@" 付きの文字列である時、間接キーとみなし もう一度 "@" を外した文字列をキーとして検索する。 key=@key という形で定義されている時、無限ループを回避するため、 @keyを直接返却する。 先頭が "@" である文字列を値として設定する際には 先頭の "@@" を "@" に変更しプロパティファイル に設定する事で、間接キー検索の機能を回避できる。

パラメータ:
key - プロパティのキー
戻り値:
指定されたキーのプロパティの値

getProperty

public static String getProperty(String key,
                                 String defaultValue)
指定されたキーのプロパティを取得する。

プロパティが見つからなかった場合には、指定されたデフォルトが返される。

パラメータ:
key - プロパティのキー
defaultValue - プロパティのデフォルト値
戻り値:
指定されたキーのプロパティの値

getPropertyNames

public static Enumeration getPropertyNames()
プロパティのすべてのキーのリストを取得する。

戻り値:
プロパティのすべてのキーのリスト

getPropertyNames

public static Enumeration<String> getPropertyNames(String keyPrefix)
指定されたプリフィックスから始まるキーのリストを取得する。

パラメータ:
keyPrefix - キーのプリフィックス
戻り値:
指定されたプリフィックスから始まるキーのリスト

getPropertiesValues

public static Set getPropertiesValues(String propertyName,
                                      String keyPrefix)
プロパティファイル名、部分キー文字列を指定することにより 値セットを取得する。

パラメータ:
propertyName - プロパティファイル名
keyPrefix - 部分キー文字列
戻り値:
値セット

getPropertyNames

public static Enumeration<String> getPropertyNames(Properties localProps,
                                                   String keyPrefix)
プロパティを指定し、部分キープリフィックスに合致する キー一覧を取得する。

パラメータ:
localProps - プロパティ
keyPrefix - 部分キープリフィックス
戻り値:
部分キープリフィックスに合致するキー一覧

getPropertiesValues

public static Set<String> getPropertiesValues(Properties localProps,
                                              Enumeration<String> propertyNames)
キー一覧に対し、プロパティより取得した値を取得する。

パラメータ:
localProps - プロパティ
propertyNames - キーの一覧
戻り値:
値セット

loadProperties

public static Properties loadProperties(String propertyName)
指定したプロパティファイル名で、プロパティオブジェクトを取得する。

パラメータ:
propertyName - プロパティファイル
戻り値:
プロパティオブジェクト


Copyright © 2011. All Rights Reserved.