ts.util.resource
インタフェース Resource

既知の実装クラスの一覧:
AbstractResource, DefaultResource, PropertyResource, XmlResource

public interface Resource

リソースクラス。
キーと値の対応を保持するクラスのインターフェイス。 キーを指定して値を取得したり、設定したりするためのメソッドを宣言している。
キーは、階層構造を持った文字列であり、各階層にあたる「要素」と同じ階層にある 複数の要素を識別するための「属性」により構成される。 要素の区切り文字を.(ピリオド)とし、属性を()で 囲むとした場合、キーの形式は次のようになる:

     <要素1>.<要素2>.<要素3>(<属性1>=<値1>,<属性2>=<値2>).<要素4>.…
 

バージョン:
$Revision: 1.1.1.1 $, $Date: 2010-10-16 00:03:49 $
作成者:
佐藤隆之.

フィールドの概要
static Resource EMPTY
          空のリソースオブジェクト。
 
メソッドの概要
 java.util.List<java.lang.String> getAttributes(java.lang.String key, java.lang.String attr)
          指定されたキーに該当する全要素の、指定された属性の値のリストを取得する。
 java.lang.String getBaseElementName()
          基底要素の名前を取得する。
 java.util.List<Resource> getChildren(java.lang.String key)
          指定されたキーに該当する全ての要素をそれぞれ基底要素とするの子リソースの リストを取得する。
 java.lang.String getFirstAttribute(java.lang.String key, java.lang.String attr)
          指定されたキーに最初に該当する要素の、指定された属性の値を取得する。
 Resource getFirstChild(java.lang.String key)
          指定されたキーに最初に該当する要素を基底要素とする子リソースを取得する。
 java.lang.String getFirstValue(java.lang.String key)
          指定されたキーに最初に該当する要素の値文字列を取得する。
 Resource getOrCreateFirstChild(java.lang.String key)
          指定されたキーに最初に該当する要素を基底要素とする子リソースを取得する。
 java.util.List<java.lang.String> getValues(java.lang.String key)
          指定されたキーに該当する全要素の値文字列のリストを取得する。
 void removeChildren(java.lang.String key)
          指定されたキーに該当する全ての要素を削除する。
 void setFirstValue(java.lang.String key, java.lang.String value)
          指定されたキーに最初に該当する要素に、値文字列を設定する。
 

フィールドの詳細

EMPTY

static final Resource EMPTY
空のリソースオブジェクト。

メソッドの詳細

getBaseElementName

java.lang.String getBaseElementName()
基底要素の名前を取得する。

戻り値:
基底要素の名前。

getFirstValue

java.lang.String getFirstValue(java.lang.String key)
                               throws IllegalKeyException
指定されたキーに最初に該当する要素の値文字列を取得する。
該当する要素が存在しない場合は空文字列を返す。 引数のキーが不正な場合は例外をスローする。

パラメータ:
key - キー文字列。
戻り値:
引数のキーに最初に該当する要素の値文字列。
例外:
IllegalKeyException - キーが不正な場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

getValues

java.util.List<java.lang.String> getValues(java.lang.String key)
                                           throws IllegalKeyException
指定されたキーに該当する全要素の値文字列のリストを取得する。
該当する要素が一つも存在しない場合は空のリストを返す。 引数のキーが不正な場合は例外をスローする。

パラメータ:
key - キー文字列。
戻り値:
引数のキーに該当する全要素の値文字列のリスト。
例外:
IllegalKeyException - キーが不正な場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

getFirstAttribute

java.lang.String getFirstAttribute(java.lang.String key,
                                   java.lang.String attr)
                                   throws IllegalKeyException
指定されたキーに最初に該当する要素の、指定された属性の値を取得する。
該当する要素が存在しない場合は空文字列を返す。 該当する要素に、指定された名前の属性が存在しない場合は空文字列を返す。 引数のキーが不正な場合は例外をスローする。

パラメータ:
key - キー文字列。
attr - 属性名。
戻り値:
引数のキーに最初に該当する要素の、指定された属性の値。
例外:
IllegalKeyException - キーが不正な場合。
AssertError - 引数がヌルの場合(デバッグモードのみ)。

getAttributes

java.util.List<java.lang.String> getAttributes(java.lang.String key,
                                               java.lang.String attr)
                                               throws IllegalKeyException
指定されたキーに該当する全要素の、指定された属性の値のリストを取得する。
該当する要素が一つも存在しない場合は空のリストを返す。 引数のキーが不正な場合は例外をスローする。

パラメータ:
key - キー文字列。
attr - 属性名。
戻り値:
引数のキーに該当する全要素の、指定された属性の値のリスト。
例外:
IllegalKeyException - キーが不正な場合。
AssertError - 引数がヌルの場合(デバッグモードのみ)。

getFirstChild

Resource getFirstChild(java.lang.String key)
                       throws IllegalKeyException
指定されたキーに最初に該当する要素を基底要素とする子リソースを取得する。
指定されたキーに該当する要素が存在しない場合は EMPTYを返す。 引数のキーが不正な場合は例外をスローする。

パラメータ:
key - キー文字列。
戻り値:
引数のキーに最初に該当する子リソース。
例外:
IllegalKeyException - キーが不正な場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

getChildren

java.util.List<Resource> getChildren(java.lang.String key)
                                     throws IllegalKeyException
指定されたキーに該当する全ての要素をそれぞれ基底要素とするの子リソースの リストを取得する。
指定されたキーに該当する要素が存在しない場合は空のリストを返す。 引数のキーが不正な場合は例外をスローする。

パラメータ:
key - キー文字列。
戻り値:
引数のキーに該当する全要素の子リソースのリスト。
例外:
IllegalKeyException - キーが不正な場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

setFirstValue

void setFirstValue(java.lang.String key,
                   java.lang.String value)
                   throws IllegalKeyException
指定されたキーに最初に該当する要素に、値文字列を設定する。
指定されたキーに該当する要素が存在しない場合は、その要素を作成して 値を設定する。 引数のキーが不正な場合は例外をスローする。

パラメータ:
key - キー文字列。
value - 指定されたキーに最初に該当する要素に設定する値。
例外:
IllegalKeyException - キーが不正な場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

getOrCreateFirstChild

Resource getOrCreateFirstChild(java.lang.String key)
                               throws IllegalKeyException
指定されたキーに最初に該当する要素を基底要素とする子リソースを取得する。 指定されたキーに該当する要素が存在しない場合は、作成して返す。
引数のキーが不正な場合は例外をスローする。

パラメータ:
key - キー文字列。
戻り値:
引数のキーに最初に該当する子リソース。
例外:
IllegalKeyException - キーが不正な場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

removeChildren

void removeChildren(java.lang.String key)
                    throws IllegalKeyException
指定されたキーに該当する全ての要素を削除する。
指定されたキーに該当する要素が存在しない場合は、そのまま何もしない。 引数のキーが不正な場合は例外をスローする。

パラメータ:
key - キー文字列。
例外:
IllegalKeyException - キーが不正な場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。


Copyright (C) SATOH Takayuki All Rights Reserved.