jp.go.aist.rtm.RTC.util
クラス Properties

java.lang.Object
  jp.go.aist.rtm.RTC.util.Properties

public class Properties
extends java.lang.Object

キーと値のセットからなるプロパティセットを表す。

ストリームへ保管したり、ストリームからロードしたりできる。 各プロパティのキー、およびそれに対応する値は文字列。 プロパティセットには、デフォルトを指定することができ、 元のプロパティセットで指定されたキーが見つからない場合には、 この２番目のプロパティセットが検索される。

コンストラクタの概要

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

Properties(java.util.Map<java.lang.String,java.lang.String> defaults)
コンストラクタ 指定されたデータでデフォルトが初期設定される

Properties(Properties prop)
コピーコンストラクタ コピー元となるPropertiesオブジェクトと同内容を持つ 別のPropertiesオブジェクトを新たに作成する。

Properties(java.lang.String key)
コンストラクタ {@.ja 指定されたキーを持つプロパティが初期設定される。

Properties(java.lang.String[] defaults)
コンストラクタ 指定されたデータでデフォルトが初期設定される。

Properties(java.lang.String key, java.lang.String value)
コンストラクタ 指定されたキーおよび値を持つプロパティが初期設定される。

メソッドの概要

protected java.io.OutputStream	_dump(java.io.OutputStream out, Properties curr, int index)
java.lang.String	_dump(java.lang.String out, Properties curr, int index) Propertiesの内容を文字列にする。
protected Properties	_getNode(java.util.Vector<java.lang.String> keys, int index, Properties curr)
protected void	_propertyNames(java.util.Vector<java.lang.String> names, java.lang.String curr_name, Properties curr)
protected void	_store(java.io.OutputStream out, java.lang.String curr_name, Properties curr)
void	clear() 子ノードを全て削除する。
boolean	createNode(java.lang.String key) 指定されたキーのPropertiesオブジェクトを、 当該Propertiesオブジェクト内に子ノードとして作成する。
void	destruct() 削除処理を行う。
protected void	finalize()
Properties	findNode(java.lang.String key) ノードを検索する
java.lang.String	getDefault(java.lang.String key) 指定されたキーに対応するデフォルト値を取得する。
java.lang.String	getDefaultValue() 当該Propertiesオブジェクトのデフォルト値を取得する。
java.util.Vector<Properties>	getLeaf() 当該Propertiesオブジェクトの子ノード群を取得する。
java.lang.String	getName() 当該Propertiesオブジェクトのキーを取得する。
Properties	getNode(java.lang.String key) 指定されたキーに対応する値を直接保持しているProperties オブジェクトを取得する
java.lang.String	getProperty(java.lang.String key) 指定されたキーに対応する値を取得する。
java.lang.String	getProperty(java.lang.String key, java.lang.String alternative) 指定されたキーに対応する値を取得する。
Properties	getRoot() 当該Propertiesオブジェクトの親ノードを取得する。
java.lang.String	getValue() 当該Propertiesオブジェクトの値を取得する。
Properties	hasKey(java.lang.String key) {@.ja 当該Propertiesオブジェクトの 直接の子ノード（つまり、孫ノード以下は含まない）の中に、 指定されたキーを持つものが存在するかどうか調べる。
protected java.lang.String	indent(int index)
void	list(java.io.OutputStream out) 指定された出力ストリームに、 当該Propertiesオブジェクトの内容を出力する。
void	load(java.io.BufferedReader reader) 指定されたリーダーから、 キーと値が対となったプロパティセットを読み込む。
void	merge(Properties prop) 指定されたPropertiesオブジェクト内のプロパティセットを、 当該Propertiesオブジェクト内にマージする。
java.util.Vector<java.lang.String>	propertyNames() 当該Propertiesオブジェクトおよび子ノード内に存在するキーの リストを取得する。
Properties	removeNode(java.lang.String name) 指定されたキーの子ノードPropertiesオブジェクトを、 当該Propertiesオブジェクトから切り離す。
void	save(java.io.OutputStream out, java.lang.String header) 当該Propertiesオブジェクトの内容を、 指定されたストリームに出力する。
java.lang.String	setDefault(java.lang.String key, java.lang.String defaultValue) 指定されたキーに対応するデフォルト値を設定する。
void	setDefaults(java.lang.String[] defaults) 指定されたキーに対応するデフォルト値を設定する。
java.lang.String	setProperty(java.lang.String key, java.lang.String value) 指定されたキーに対応する値を登録する。
int	size() 当該Propertiesオブジェクトおよび子ノード内に存在するプロパティの 数を取得する。
protected boolean	split(java.lang.String str, char delim, java.util.Vector<java.lang.String> values) 指定された文字列を指定したデリミタで分離した結果を取得する。
protected Pair<java.lang.String,java.lang.String>	splitKeyValue(java.lang.String str) 指定された文字列を、 所定のデリミタによってキーと値のペアに分離する。
void	store(java.io.OutputStream out, java.lang.String header) 当該Propertiesオブジェクトの内容を、 指定されたストリームに出力する。
void	substitute(Properties prop) 指定されたPropertiesオブジェクトの内容を、 当該Propertiesオブジェクトに設定する。

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

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

コンストラクタの詳細

Properties

public Properties()

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

Properties

public Properties(java.lang.String key)

コンストラクタ

指定されたキーを持つプロパティが初期設定される。 指定されたキーに対応する値は空文字列となる。

パラメータ:

key - キー

Properties

public Properties(java.lang.String key,
                  java.lang.String value)

コンストラクタ

指定されたキーおよび値を持つプロパティが初期設定される。

パラメータ:

key - キー

value - 値

Properties

public Properties(java.util.Map<java.lang.String,java.lang.String> defaults)

コンストラクタ

指定されたデータでデフォルトが初期設定される

パラメータ:

defaults - デフォルトとなるキーと値を持つMapオブジェクト

Properties

public Properties(java.lang.String[] defaults)

コンストラクタ

指定されたデータでデフォルトが初期設定される。

パラメータ:

defaults - デフォルト値を、キー・値の順に交互に並べたもの

Properties

public Properties(Properties prop)

コピーコンストラクタ

コピー元となるPropertiesオブジェクトと同内容を持つ 別のPropertiesオブジェクトを新たに作成する。

パラメータ:

prop - コピー元となるPropertiesオブジェクト

メソッドの詳細

substitute

public void substitute(Properties prop)

指定されたPropertiesオブジェクトの内容を、 当該Propertiesオブジェクトに設定する。

パラメータ:

prop - コピー元となるPropertiesオブジェクト

destruct

public void destruct()

削除処理を行う。

当該Propertiesオブジェクトの内容をクリアして、 親ノードから切り離す。 また、すべての子ノードについても削除処理を行う。

finalize

protected void finalize()
                 throws java.lang.Throwable

オーバーライド:

クラス java.lang.Object 内の finalize

例外:

java.lang.Throwable

getName

public java.lang.String getName()

当該Propertiesオブジェクトのキーを取得する。

戻り値:

キー

getValue

public java.lang.String getValue()

当該Propertiesオブジェクトの値を取得する。

戻り値:

値

getDefaultValue

public java.lang.String getDefaultValue()

当該Propertiesオブジェクトのデフォルト値を取得する。

戻り値:

デフォルト値

getLeaf

public java.util.Vector<Properties> getLeaf()

当該Propertiesオブジェクトの子ノード群を取得する。

戻り値:

子ノードPropertiesオブジェクトリスト

getRoot

public Properties getRoot()

当該Propertiesオブジェクトの親ノードを取得する。

戻り値:

親ノードPropertiesオブジェクト

getProperty

public java.lang.String getProperty(java.lang.String key)

指定されたキーに対応する値を取得する。

パラメータ:

key - キー

戻り値:

指定されたキーに対応する値を返す。 指定されたキーが存在するが値が設定されていない場合は、 デフォルト値を返す。 また、指定されたキーが存在しない場合は空文字列を返す。

getProperty

public java.lang.String getProperty(java.lang.String key,
                                    java.lang.String alternative)

指定されたキーに対応する値を取得する。

ただし、指定されたキーが存在しない場合や、 キーに対応する値が空文字列である場合は、指定された代替値が取得される。

パラメータ:

key - i キー

alternative - 代替値

戻り値:

指定されたキーに対応する値を返す。 指定されたキーが存在しない場合や、 キーに対応する値が空文字列である場合は、代替値を返す。

getDefault

public java.lang.String getDefault(java.lang.String key)

指定されたキーに対応するデフォルト値を取得する。

パラメータ:

key - キー

戻り値:

指定されたキーが存在する場合は、 それに対応するデフォルト値を返す。 指定されたキーが存在しない場合は、空文字列を返す。

setProperty

public java.lang.String setProperty(java.lang.String key,
                                    java.lang.String value)

指定されたキーに対応する値を登録する。

パラメータ:

key - キー

value - キーに対応する値

戻り値:

以前の設定値を返す。 以前の設定値が存在しない場合は、デフォルト値を返す。

setDefault

public java.lang.String setDefault(java.lang.String key,
                                   java.lang.String defaultValue)

指定されたキーに対応するデフォルト値を設定する。

パラメータ:

key - キー

defaultValue - キーに対応する新たなデフォルト値

setDefaults

public void setDefaults(java.lang.String[] defaults)

指定されたキーに対応するデフォルト値を設定する。

パラメータ:

defaults - デフォルト値を、キー・値の順に交互に並べたもの

list

public void list(java.io.OutputStream out)

指定された出力ストリームに、 当該Propertiesオブジェクトの内容を出力する。

パラメータ:

out - 出力先ストリーム

load

public void load(java.io.BufferedReader reader)
          throws java.io.IOException

指定されたリーダーから、 キーと値が対となったプロパティセットを読み込む。

パラメータ:

reader - 読み込み元となるリーダー。

例外:

java.io.IOException

save

public void save(java.io.OutputStream out,
                 java.lang.String header)

当該Propertiesオブジェクトの内容を、 指定されたストリームに出力する。

パラメータ:

out - 出力先ストリーム

header - 出力内容の先頭に付加されるヘッダコメント文字列

store

public void store(java.io.OutputStream out,
                  java.lang.String header)

当該Propertiesオブジェクトの内容を、 指定されたストリームに出力する。

パラメータ:

out - 出力先ストリーム

header - 出力内容の先頭に付加されるヘッダコメント文字列

propertyNames

public final java.util.Vector<java.lang.String> propertyNames()

当該Propertiesオブジェクトおよび子ノード内に存在するキーの リストを取得する。

戻り値:

キーのリスト

size

public final int size()

当該Propertiesオブジェクトおよび子ノード内に存在するプロパティの 数を取得する。

戻り値:

プロパティ数

findNode

public final Properties findNode(java.lang.String key)

ノードを検索する

パラメータ:

key - キー

戻り値:

Properties

getNode

public final Properties getNode(java.lang.String key)

指定されたキーに対応する値を直接保持しているProperties オブジェクトを取得する

パラメータ:

key - キー

戻り値:

指定されたキーに対応する値を直接保持しているProperties オブジェクト

createNode

public boolean createNode(java.lang.String key)

指定されたキーのPropertiesオブジェクトを、 当該Propertiesオブジェクト内に子ノードとして作成する。

パラメータ:

key - キー

戻り値:

指定されたキーがすでに存在していた場合はfalseを、 さもなくばtrueを返す。

removeNode

public Properties removeNode(java.lang.String name)

指定されたキーの子ノードPropertiesオブジェクトを、 当該Propertiesオブジェクトから切り離す。

パラメータ:

name - 切り離したい子ノードのキー

戻り値:

切り離された子ノードPropertiesオブジェクトを返す。 指定されたキーに対応する子ノードが存在しない場合は、nullを返す。

hasKey

public final Properties hasKey(java.lang.String key)

当該Propertiesオブジェクトの 直接の子ノード（つまり、孫ノード以下は含まない）の中に、 指定されたキーを持つものが存在するかどうか調べる。存在する場合には、 そのPropertiesオブジェクトを取得する。

パラメータ:

key - キー

戻り値:

指定されたキーに対応するPropertiesオブジェクトを返す。 指定されたキーに対応するPropertiesオブジェクトが存在しない場合は、 nullを返す。

clear

public void clear()

子ノードを全て削除する。

merge

public void merge(Properties prop)

指定されたPropertiesオブジェクト内のプロパティセットを、 当該Propertiesオブジェクト内にマージする。

ただし、デフォルト値はマージされない。

パラメータ:

prop - マージ元となるPropertiesオブジェクト

splitKeyValue

protected Pair<java.lang.String,java.lang.String> splitKeyValue(java.lang.String str)

指定された文字列を、 所定のデリミタによってキーと値のペアに分離する。

パラメータ:

str - 分離対象となる文字列。 通常は、キーと値がデリミタで区切られている文字列。

戻り値:

キーと値を格納するPairオブジェクト。

split

protected boolean split(java.lang.String str,
                        char delim,
                        java.util.Vector<java.lang.String> values)

指定された文字列を指定したデリミタで分離した結果を取得する。

パラメータ:

str - 分離対象となる文字列

delim - デリミタ

戻り値:

分離された文字列のリスト

indent

protected java.lang.String indent(int index)

_getNode

protected Properties _getNode(java.util.Vector<java.lang.String> keys,
                              int index,
                              Properties curr)

_propertyNames

protected void _propertyNames(java.util.Vector<java.lang.String> names,
                              java.lang.String curr_name,
                              Properties curr)

_store

protected void _store(java.io.OutputStream out,
                      java.lang.String curr_name,
                      Properties curr)

_dump

protected java.io.OutputStream _dump(java.io.OutputStream out,
                                     Properties curr,
                                     int index)

_dump

public java.lang.String _dump(java.lang.String out,
                              Properties curr,
                              int index)

Propertiesの内容を文字列にする。

パラメータ:

out - 出力用文字列

curr - Properties

index - 階層