pexa.share.util.prop

クラス PropertyReader

java.lang.Object

pexa.share.util.prop.PropertyReader

public class PropertyReader
extends java.lang.Object

Class that reads properties and returns it

バージョン:

$Revision: 2869 $, $Date:: 2008-12-05 22:30:20 #$

作成者:

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static java.lang.String	DEFAULT_PROPBASE_NAME_PROPNAME
static java.lang.String	NESTED_PROP_SUFFIX Suffix indicates nested property
static java.lang.String	NESTED_SUBPROPS_DELIMITOR Delimitor of properties of sub properties
static java.lang.String	NESTED_SUBPROPS_PROPNAME Property name for obtain sub properties of nested properties
static java.lang.String	PROP_DELIMITOR Delimitor of properties
static java.lang.String	PROPERTY_NAME Property name of PropertyReader
static java.lang.String	RESPROP_NAME_SUFFIX Suffix of resource file name in system properties This is suffix for obtaining and setting resource file name.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static java.util.Map	getLocalPropertiesFor(java.lang.String propName) Read local properties of specified name from resource file
static java.util.Map	getProperties() Read properties from resource file
static java.util.Map	getPropertiesFor(java.lang.String propName) Read properties of specified name from resource file

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

PROPERTY_NAME

public static final java.lang.String PROPERTY_NAME

Property name of PropertyReader

関連項目:

定数フィールド値

RESPROP_NAME_SUFFIX

public static java.lang.String RESPROP_NAME_SUFFIX

Suffix of resource file name in system properties

This is suffix for obtaining and setting resource file name. Using property name "Property Name" concatenated with "RESPROP_NAME_SUFFIX", It enables to obtain resource file name from system properties and specify other resource file name differred from default resoure filen name named "Property Name"+".properties".

DEFAULT_PROPBASE_NAME_PROPNAME

public static final java.lang.String DEFAULT_PROPBASE_NAME_PROPNAME

関連項目:

定数フィールド値

PROP_DELIMITOR

public static final java.lang.String PROP_DELIMITOR

Delimitor of properties

関連項目:

定数フィールド値

NESTED_PROP_SUFFIX

public static final java.lang.String NESTED_PROP_SUFFIX

Suffix indicates nested property

関連項目:

定数フィールド値

NESTED_SUBPROPS_PROPNAME

public static final java.lang.String NESTED_SUBPROPS_PROPNAME

Property name for obtain sub properties of nested properties

関連項目:

定数フィールド値

NESTED_SUBPROPS_DELIMITOR

public static final java.lang.String NESTED_SUBPROPS_DELIMITOR

Delimitor of properties of sub properties

関連項目:

定数フィールド値

メソッドの詳細

getProperties

public static java.util.Map getProperties()
                                   throws PropertyReadException

Read properties from resource file

戻り値:

Obtained properties

例外:

PropertyReadException - Reading properties failed.

This method obtains properties started with "DEFAULT_PROPBASE_NAME" using getPropertiesFor(String) method. The gotten properties are cached.

getPropertiesFor

public static java.util.Map getPropertiesFor(java.lang.String propName)
                                      throws PropertyReadException

Read properties of specified name from resource file

パラメータ:

propName - Property name

戻り値:

Obtained properties

例外:

java.lang.IllegalArgumentException - Invalid argument is specified.

PropertyReadException - Reading properties failed.

This method obtains properties specified in argument from resource file. If resource file name is specified in system properties, the specified file is read.

Properties values can be specified in system properties(-D>key<=>value<). In this case, the properties started with properties name specified in argument is obtained. If the value obtained from system properties is defined in properties file, that of system properties is adopted.

The properties value can be nested. See PropertyReader.NestedPropertyReader.read(String).

関連項目:

Key

getLocalPropertiesFor

public static java.util.Map getLocalPropertiesFor(java.lang.String propName)
                                           throws PropertyReadException

Read local properties of specified name from resource file

パラメータ:

propName - Property name

戻り値:

Obtained properties

例外:

java.lang.IllegalArgumentException - Invalid argument is specified.

PropertyReadException - Reading properties failed.

This method obtains properties specified in argument from resource file. If resource file name is specified in system properties, the specified file is read.

This method is differ from getProperties(String) method in properties key. The properties does not have to start with property name specified in argument. If the value obtained from system properties is defined in properties file, that of system properties is adopted.

The properties value can be nested. See PropertyReader.NestedPropertyReader.read(String).

関連項目:

Key