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

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

public class NVUtil
extends java.lang.Object

NameValue操作用ユーティリティクラスです。


入れ子のクラスの概要
(package private) static class NVUtil.nv_find
          指定された名称を持つNameValueオブジェクトを検索するためのヘルパクラスです。
(package private) static class NVUtil.to_prop
          指定されたNameValueオブジェクトの内容を元にPropertiesオブジェクトを作成する ヘルパクラスです。
 
コンストラクタの概要
NVUtil()
           
 
メソッドの概要
static void append(NVListHolder destNvList, NVListHolder srcNvList)
          片方のNameValueListオブジェクトが内包するNameValueオブジェクトリストを、 もう一方のNameValueListオブジェクト内に追加します。
static boolean appendStringValue(NVListHolder nvlist, java.lang.String name, java.lang.String value)
          NVListHolderが内包するNameValueオブジェクトリストの中から、指定した名称を持つ NameValueオブジェクトを検索して、そのオブジェクトに指定した文字列値を追加します。
指定した名称を持つNameValueオブジェクトが存在しない場合には、その名称と指定された値を持つ NameValueが新たに作成され、NVListHolder内のNameValueオブジェクトリストに追加されます。
static void copyFromProperties(NVListHolder nvlist, Properties prop)
          指定されたPropertiesを用いてNameValueオブジェクトリストを作成し、 それを指定されたNVListHolder内にコピーします。
Propertiesのキーおよび値が、各NameValueの名称および値にそれぞれ割り当てられます。
static void copyToProperties(Properties prop, NVListHolder nvlist)
          指定されたNVListHolderに保持されているNameValueオブジェクトリストの内容を、 指定されたPropertiesオブジェクトにコピーします。
各NameValueの名称および値が、Propertiesのキーおよび値にそれぞれ割り当てられます。
static void dump(NVListHolder nvlist)
          指定されたNVListHolderオブジェクトが内包するNameValueオブジェクトリストの内容を、 標準出力に出力します。
static int find_index(NVListHolder nvlist, java.lang.String name)
          NVListHolderが内包するNameValueオブジェクトリストの中から、指定した名称を持つ NameValueオブジェクトを検索して、そのオブジェクトのリスト内でのインデクスを取得します。
static org.omg.CORBA.Any find(NVListHolder nvlist, java.lang.String name)
          NVListHolderが内包するNameValueオブジェクトリストの中から、指定した名称を持つ NameValueオブジェクトを検索して、そのオブジェクトが持つ値をAny型で取得します。
static boolean isString(NVListHolder nvlist, java.lang.String name)
          NVListHolderが内包するNameValueオブジェクトリストの中から、指定した名称を持つ NameValueオブジェクトを検索して、そのオブジェクトが持つ値が文字列型かどうかを調べます。
static boolean isStringValue(NVListHolder nvlist, java.lang.String name, java.lang.String value)
          NVListHolderが内包するNameValueオブジェクトリストの中から、指定した名称を持つ NameValueオブジェクトを検索して、そのオブジェクトが持つ値が文字列型かどうかを調べます。 文字列型の場合は、さらに指定された文字列値に一致するかどうかを調べます。
static NameValue newNV(java.lang.String name, java.lang.String value)
          指定されたデータを用いてNameValueオブジェクトを作成します。
static
<T> NameValue
newNV(java.lang.String name, T value, java.lang.Class<T> klass)
          指定されたデータを用いてNameValueオブジェクトを作成します。
static NameValue newNVAny(java.lang.String name, org.omg.CORBA.Any value)
          指定されたデータを用いてNameValueオブジェクトを作成します。
static NameValue newNVString(java.lang.String name, java.lang.String value)
          指定されたデータを用いてNameValueオブジェクトを作成します。
static Properties toProperties(NVListHolder nvlist)
          指定されたNVListHolderに保持されているNameValueオブジェクトリストの内容をもとに、 Propertiesオブジェクトを作成します。
各NameValueの名称および値が、Propertiesのキーおよび値にそれぞれ割り当てられます。
static java.lang.String toString(NVListHolder nvlist)
          NVListHolderが内包するNameValueオブジェクトリストの中から、 そのオブジェクトが持つ値を文字列型で取得します。
static java.lang.String toString(NVListHolder nvlist, java.lang.String name)
          NVListHolderが内包するNameValueオブジェクトリストの中から、指定した名称を持つ NameValueオブジェクトを検索して、そのオブジェクトが持つ値を文字列型で取得します。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

NVUtil

public NVUtil()
メソッドの詳細

newNV

public static <T> NameValue newNV(java.lang.String name,
                                  T value,
                                  java.lang.Class<T> klass)

指定されたデータを用いてNameValueオブジェクトを作成します。

パラメータ:
name - オブジェクトに設定する名称
value - オブジェクトに設定する値
klass - オブジェクトに設定する値の型
戻り値:
作成されたNameValueオブジェクト

newNVString

public static NameValue newNVString(java.lang.String name,
                                    java.lang.String value)

指定されたデータを用いてNameValueオブジェクトを作成します。

パラメータ:
name - オブジェクトに設定する名称
value - オブジェクトに設定する値(String)
戻り値:
作成されたNameValueオブジェクト

newNV

public static NameValue newNV(java.lang.String name,
                              java.lang.String value)

指定されたデータを用いてNameValueオブジェクトを作成します。

パラメータ:
name - オブジェクトに設定する名称
value - オブジェクトに設定するString値
戻り値:
作成されたNameValueオブジェクト

newNVAny

public static NameValue newNVAny(java.lang.String name,
                                 org.omg.CORBA.Any value)

指定されたデータを用いてNameValueオブジェクトを作成します。

パラメータ:
name - オブジェクトに設定する名称
value - オブジェクトに設定するAny値
戻り値:
作成されたNameValueオブジェクト

copyFromProperties

public static void copyFromProperties(NVListHolder nvlist,
                                      Properties prop)

指定されたPropertiesを用いてNameValueオブジェクトリストを作成し、 それを指定されたNVListHolder内にコピーします。
Propertiesのキーおよび値が、各NameValueの名称および値にそれぞれ割り当てられます。

パラメータ:
nvlist - 作成されたNameValueオブジェクトリストを受け取るためNVListHolder
prop - 設定元となるPropertiesオブジェクト

copyToProperties

public static void copyToProperties(Properties prop,
                                    NVListHolder nvlist)

指定されたNVListHolderに保持されているNameValueオブジェクトリストの内容を、 指定されたPropertiesオブジェクトにコピーします。
各NameValueの名称および値が、Propertiesのキーおよび値にそれぞれ割り当てられます。

パラメータ:
prop - コピー先のPropertiesオブジェクト
nvlist - コピー元のNameValueオブジェクトリストを内包するNVListHolderオブジェクト

toProperties

public static Properties toProperties(NVListHolder nvlist)

指定されたNVListHolderに保持されているNameValueオブジェクトリストの内容をもとに、 Propertiesオブジェクトを作成します。
各NameValueの名称および値が、Propertiesのキーおよび値にそれぞれ割り当てられます。

パラメータ:
nvlist - 元となるNameValueオブジェクトリストを内包するNVListHolderオブジェクト
戻り値:
作成されたPropertiesオブジェクト

find

public static final org.omg.CORBA.Any find(NVListHolder nvlist,
                                           java.lang.String name)
                                    throws java.lang.Exception

NVListHolderが内包するNameValueオブジェクトリストの中から、指定した名称を持つ NameValueオブジェクトを検索して、そのオブジェクトが持つ値をAny型で取得します。

パラメータ:
nvlist - 検索対象となるNameValueオブジェクトリストを内包するNVListHolderオブジェクト
name - 検索したいNameValueオブジェクトの名称
戻り値:
指定した名称を持つNameValueオブジェクトのAny値
例外:
java.lang.Exception - 指定した名称のNameValueオブジェクトが見つからない場合

find_index

public static final int find_index(NVListHolder nvlist,
                                   java.lang.String name)

NVListHolderが内包するNameValueオブジェクトリストの中から、指定した名称を持つ NameValueオブジェクトを検索して、そのオブジェクトのリスト内でのインデクスを取得します。

パラメータ:
nvlist - 検索対象となるNameValueオブジェクトリストを内包するNVListHolderオブジェクト
name - 検索したいNameValueオブジェクトの名称
戻り値:
指定した名称を持つNameValueオブジェクトが見つかった場合は、 そのオブジェクトのリスト内でのインデクスを返します。
また、見つからない場合は、-1を返します。

isString

public static boolean isString(NVListHolder nvlist,
                               java.lang.String name)

NVListHolderが内包するNameValueオブジェクトリストの中から、指定した名称を持つ NameValueオブジェクトを検索して、そのオブジェクトが持つ値が文字列型かどうかを調べます。

パラメータ:
nvlist - 検索対象となるNameValueオブジェクトリストを内包するNVListHolderオブジェクト
name - 検索したいNameValueオブジェクトの名称
戻り値:
見つかったNameValueオブジェクトの値が文字列型の場合はtrueを、 そうでなければfalseを返します。

isStringValue

public static boolean isStringValue(NVListHolder nvlist,
                                    java.lang.String name,
                                    java.lang.String value)

NVListHolderが内包するNameValueオブジェクトリストの中から、指定した名称を持つ NameValueオブジェクトを検索して、そのオブジェクトが持つ値が文字列型かどうかを調べます。 文字列型の場合は、さらに指定された文字列値に一致するかどうかを調べます。

パラメータ:
nvlist - 検索対象となるNameValueオブジェクトリストを内包するNVListHolderオブジェクト
name - 検索したいNameValueオブジェクトの名称
戻り値:
見つかったNameValueオブジェクトの値が文字列型で、かつ指定された文字列値に 一致する場合はtrueを返します。また、そうでなければfalseを返します。

toString

public static java.lang.String toString(NVListHolder nvlist,
                                        java.lang.String name)

NVListHolderが内包するNameValueオブジェクトリストの中から、指定した名称を持つ NameValueオブジェクトを検索して、そのオブジェクトが持つ値を文字列型で取得します。

パラメータ:
nvlist - 検索対象となるNameValueオブジェクトリストを内包するNVListHolderオブジェクト
name - 検索したいNameValueオブジェクトの名称
戻り値:
指定した名称を持つNameValueオブジェクトの文字列値を返します。
ただし、指定した名称を持つNameValueオブジェクトが見つからない場合や、 NameValueオブジェクトの値が文字列型でない場合は、空文字列を返します。
例外:
java.lang.Exception - 指定した名称のNameValueオブジェクトが見つからない場合

appendStringValue

public static boolean appendStringValue(NVListHolder nvlist,
                                        java.lang.String name,
                                        java.lang.String value)

NVListHolderが内包するNameValueオブジェクトリストの中から、指定した名称を持つ NameValueオブジェクトを検索して、そのオブジェクトに指定した文字列値を追加します。
指定した名称を持つNameValueオブジェクトが存在しない場合には、その名称と指定された値を持つ NameValueが新たに作成され、NVListHolder内のNameValueオブジェクトリストに追加されます。

パラメータ:
nvlist - 検索対象となるNameValueオブジェクトリストを内包するNVListHolderオブジェクト
name - 検索したいNameValueオブジェクトの名称
value - 見つかったNameValueオブジェクトの値に追加したい文字列値

append

public static void append(NVListHolder destNvList,
                          NVListHolder srcNvList)

片方のNameValueListオブジェクトが内包するNameValueオブジェクトリストを、 もう一方のNameValueListオブジェクト内に追加します。

パラメータ:
destNvList - 追加先となるNVListHolderオブジェクト
srcNvList - 追加元となるNVListHolderオブジェクト

dump

public static void dump(NVListHolder nvlist)

指定されたNVListHolderオブジェクトが内包するNameValueオブジェクトリストの内容を、 標準出力に出力します。

パラメータ:
nvlist - 表示対象となるNameValueオブジェクトリストを内包するNVListHolderオブジェクト

toString

public static java.lang.String toString(NVListHolder nvlist)

NVListHolderが内包するNameValueオブジェクトリストの中から、 そのオブジェクトが持つ値を文字列型で取得します。

パラメータ:
nvlist - NVListHolderオブジェクト
戻り値:
NameValueオブジェクトの文字列値を返します。
例外:
java.lang.Exception - 指定した名称のNameValueオブジェクトが見つからない場合