shohaku.configutils
クラス XMLProperties

java.lang.Object
  shohaku.configutils.XMLProperties

すべての実装インタフェース:

ConfigurationResources, ConfigurationResourcesLoader

public class XMLProperties

extends java.lang.Object

implements ConfigurationResources, ConfigurationResourcesLoader

XMLで定義されたプロパティを読み込み保存する機能を提供します。

例：

 <xml-properties>
     <content name="foo">
          <byte name="byte">-123</byte>
          <double name="double">+1,521,414.012411</double>
          <int name="int">100</int>
          <string name="string">文字列</string>
          <list id="season" desc="四季">
              <string>春</ref>
              <string>夏</ref>
              <string>秋</ref>
              <string>冬</ref>
          </list>
     </content>
 </xml-properties>
 

は以下の様に '/' で区切られた名前階層パスにマッピングされ生成されます。

 foo/byte   = -123
 foo/double = 1521414.012411
 foo/int    = 100
 foo/string = "文字列"
 foo/season = ["春", "夏", "秋", "冬"]
 

有効な階層の深さは定義ファイルで変更出来ますが、デフォルトは４階層です。

コンストラクタの概要

XMLProperties()
デフォルトコンストラクタ。

メソッドの概要

boolean	containsKey(java.lang.String key) 指定されたキーがプロパティセットに含まれている場合に true を返す。
boolean	containsKey(java.lang.String key, java.lang.Class type) 指定されたキーがプロパティセットに含まれていると同時に、 指定されたクラスとキャスト可能な関係に有る場合に true を返す。
java.lang.ClassLoader	getClassLoader() 解析処理に使用する ClassLoader を返します.
static shohaku.composer.CompositeRule	getDefaultComposeRule() デフォルトの構成ルールを返却します。
java.util.Set	getNames() 全てのプロパティ名を返す。
java.lang.Object	getObject(java.lang.String key) プロパティキーが示す値を返却します。
java.lang.Object	getObject(java.lang.String key, java.lang.Object defaultValue) プロパティキーが示す値を返却します。
java.util.Iterator	keyIterator() 全てのプロパティキーを含む反復子を返却します。
void	load(java.io.InputStream inStream) 入力ストリームからプロパティリストを読み込む。
void	load(java.io.InputStream inStream, shohaku.composer.CompositeRule rule) 入力ストリームからプロパティリストを読み込む。
void	setClassLoader(java.lang.ClassLoader classLoader) 解析処理に使用する ClassLoader を設定します.
java.util.Map	toMap() 全てのプロパティをMapに格納して返却します。

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

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

コンストラクタの詳細

XMLProperties

public XMLProperties()

デフォルトコンストラクタ。

メソッドの詳細

getClassLoader

public java.lang.ClassLoader getClassLoader()

解析処理に使用する ClassLoader を返します.

戻り値:

解析処理に使用する ClassLoader

setClassLoader

public void setClassLoader(java.lang.ClassLoader classLoader)

解析処理に使用する ClassLoader を設定します.

パラメータ:

classLoader - 解析処理に使用する ClassLoader

load

public void load(java.io.InputStream inStream)
          throws shohaku.composer.CompositeException

入力ストリームからプロパティリストを読み込む。

定義:

インタフェース ConfigurationResourcesLoader 内の load

パラメータ:

inStream - プロパティの入力ストリーム

例外:

shohaku.composer.CompositeException - 構成情報例外

load

public void load(java.io.InputStream inStream,
                 shohaku.composer.CompositeRule rule)
          throws shohaku.composer.CompositeException

入力ストリームからプロパティリストを読み込む。

定義:

インタフェース ConfigurationResourcesLoader 内の load

パラメータ:

inStream - プロパティの入力ストリーム

rule - 構成ルール

例外:

shohaku.composer.CompositeException - 構成情報例外

toMap

public java.util.Map toMap()

全てのプロパティをMapに格納して返却します。
読取専用Mapで返却します。

戻り値:

全てのプロパティ

getNames

public java.util.Set getNames()

全てのプロパティ名を返す。

戻り値:

全てのプロパティ名

keyIterator

public java.util.Iterator keyIterator()

全てのプロパティキーを含む反復子を返却します。

定義:

インタフェース ConfigurationResources 内の keyIterator

戻り値:

全てのプロパティキーを含む反復子

getObject

public java.lang.Object getObject(java.lang.String key)

プロパティキーが示す値を返却します。 指定されたキーが存在しない場合Nullを返却します。

定義:

インタフェース ConfigurationResources 内の getObject

パラメータ:

key - プロパティ名

戻り値:

指定された値

例外:

java.lang.NullPointerException - key が null の場合発生する

getObject

public java.lang.Object getObject(java.lang.String key,
                                  java.lang.Object defaultValue)

プロパティキーが示す値を返却します。 指定されたキーが存在しない場合 defaultValue を返却します。

定義:

インタフェース ConfigurationResources 内の getObject

パラメータ:

key - プロパティキー

defaultValue - プロパティキー

戻り値:

プロパティキーが示す値

例外:

java.lang.NullPointerException - key が null の場合発生する

containsKey

public boolean containsKey(java.lang.String key)

指定されたキーがプロパティセットに含まれている場合に true を返す。

定義:

インタフェース ConfigurationResources 内の containsKey

パラメータ:

key - プロパティキー

戻り値:

指定されたキーが含まれている場合 true

例外:

java.lang.NullPointerException - key が null の場合発生する

containsKey

public boolean containsKey(java.lang.String key,
                           java.lang.Class type)

指定されたキーがプロパティセットに含まれていると同時に、 指定されたクラスとキャスト可能な関係に有る場合に true を返す。 値がNullの場合キャスト可能(True)を返却します。

定義:

インタフェース ConfigurationResources 内の containsKey

パラメータ:

key - プロパティキー

type - キャスト可能な関係に有るか検証するクラス

戻り値:

指定されたキーが含まれている場合 true

例外:

java.lang.NullPointerException - key または type が null の場合発生する

getDefaultComposeRule

public static shohaku.composer.CompositeRule getDefaultComposeRule()

デフォルトの構成ルールを返却します。

戻り値:

デフォルトの構成ルール