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オブジェクトを検索して、 そのオブジェクトに指定した文字列値を追加する。
static void	copyFromProperties(NVListHolder nvlist, Properties prop) 指定されたPropertiesを用いてNameValueオブジェクトリストを作成し、 それを指定されたNVListHolder内にコピーする Propertiesのキーおよび値が、 各NameValueの名称および値にそれぞれ割り当てらる {@.en This operation copies the properties to NVList.
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型で取得する {@.en This operation returns Any type of value specified by name.
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オブジェクトを検索して、 そのオブジェクトが持つ値を文字列型で取得する {@.en This operation returns string value in NVList specified by name.

クラスから継承されたメソッド 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オブジェクトの名称

value - 比較する文字

戻り値:

見つかった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オブジェクトの値が 文字列型でない場合は、空文字列を返す。

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オブジェクトの値に追加したい文字列値

戻り値:

trueを返す。

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オブジェクトの文字列値を返す。 String value of NameValue objcet

例外:

java.lang.Exception - 指定した名称のNameValueオブジェクトが見つからない場合