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

java.lang.Object
  上位を拡張 jp.go.aist.rtm.RTC.util.Properties

public class Properties
extends java.lang.Object

キーと値のセットからなるプロパティセットを表します。 ストリームへ保管したり、ストリームからロードしたりできます。 各プロパティのキー、およびそれに対応する値は文字列です。

プロパティセットには、デフォルトを指定することができ、 元のプロパティセットで指定されたキーが見つからない場合には、 この2番目のプロパティセットが検索されます。


コンストラクタの概要
Properties()
          デフォルトコンストラクタです。
Properties(java.util.Map<java.lang.String,java.lang.String> defaults)
          コンストラクタです。
Properties(Properties prop)
          コピーコンストラクタです。
Properties(java.lang.String key)
          コンストラクタです。
Properties(java.lang.String[] defaults)
          コンストラクタです。
Properties(java.lang.String key, java.lang.String value)
          コンストラクタです。
 
メソッドの概要
 void clear()
          子ノードを全て削除します。
 boolean createNode(java.lang.String key)
          指定されたキーのPropertiesオブジェクトを、当該Propertiesオブジェクト内に 子ノードとして作成します。
 void destruct()
          削除処理を行います。
 java.lang.String getDefault(java.lang.String key)
          指定されたキーに対応するデフォルト値を取得します。
 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オブジェクトの親ノードを取得します。
 Properties hasKey(java.lang.String key)
          当該Propertiesオブジェクトの直接の子ノード(つまり、孫ノード以下は含まない)の中に、 指定されたキーを持つものが存在するかどうか調べます。
 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オブジェクトおよび子ノード内に存在するプロパティの数を取得します。
 void store(java.io.OutputStream out, java.lang.String header)
          当該Propertiesオブジェクトの内容を、指定されたストリームに出力します。
 void substitute(Properties prop)
          指定されたPropertiesオブジェクトの内容を、当該Propertiesオブジェクトに設定します。
 
クラス java.lang.Object から継承されたメソッド
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オブジェクトの内容をクリアして、 親ノードから切り離します。また、すべての子ノードについても削除処理を行います。


getName

public java.lang.String getName()

当該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)

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

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

getProperty

public java.lang.String getProperty(java.lang.String key,
                                    java.lang.String alternative)
指定されたキーに対応する値を取得します。ただし、指定されたキーが存在しない場合や、 キーに対応する値が空文字列である場合は、指定された代替値が取得されます。

パラメータ:
key - キー
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オブジェクトおよび子ノード内に存在するプロパティの数を取得します。

戻り値:
プロパティ数

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オブジェクト