shohaku.shoin
クラス XResourceBundle

java.lang.Object
  拡張shohaku.shoin.XResourceBundle
すべての実装インタフェース:
ResourceSet
直系の既知のサブクラス:
AbstractGinkgoXResourceBundle, OgdlResourceBundle, SimpleResourceBundle

public abstract class XResourceBundle
extends java.lang.Object
implements ResourceSet

拡張可能な階層化リソースバンドルの抽象実装を提供します。
この拡張可能なリソースバンドルは java.util.ResourceBundle 同様に地域対応に主眼を置きますが、その用途に制限を持ちません。
論理的には階層化されたリソースは全て実装の対象とすることが出来ます。

リソースを定義するファイル形式には XResourceBundleCreater で実装出来る任意の形式を利用できます。
階層化されたリソースをキャッシュし束ねるには XResourceBundleCache を使用します。
またリソースを束ね階層化する基準とファイル名の規約には XResourceBundleBaseCalculator の実装として任意に定義出来ます。
そのため java.util.ResourceBundle に於ける java.util.Locale のファイル名規約のと同等のファイル接尾辞を設計し、
それを示すクラスを定義する事で、容易に独自基準で階層化されたリソースバンドルを構築出来ます。


フィールドの概要
protected  XResourceBundleBase bundleBase
          束縛基準を格納します。
protected  ResourceSet lookup
          リソースを格納します。
protected  XResourceBundle parent
          親バンドルを格納します。
 
コンストラクタの概要
protected XResourceBundle(XResourceBundle parent, XResourceBundleBase bundleBase, ResourceSet resources)
          リソースリストを初期化します。
 
メソッドの概要
 boolean containsKey(java.lang.Object key)
          指定されたキーがリソースセットに含まれている場合に true を返却します。
 java.util.Iterator getKeys()
          このバンドルと上位階層の全てのリソースキーの反復子を返却します。
 java.util.Map getMapView()
          リソース集合のマップ表現を返却します。
 java.lang.Object getObject(java.lang.Object key)
          リソースキーが示す値を返却します。
 java.lang.Object getObject(java.lang.Object key, java.lang.Object defaultValue)
          指定された文字列型のキーが示す値を返却します。
 int size()
          リソースの数を返却します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

lookup

protected final ResourceSet lookup
リソースを格納します。


parent

protected final XResourceBundle parent
親バンドルを格納します。


bundleBase

protected final XResourceBundleBase bundleBase
束縛基準を格納します。

コンストラクタの詳細

XResourceBundle

protected XResourceBundle(XResourceBundle parent,
                          XResourceBundleBase bundleBase,
                          ResourceSet resources)
リソースリストを初期化します。

パラメータ:
parent - 親バンドル
bundleBase - 束縛基準
resources - リソース
メソッドの詳細

getKeys

public java.util.Iterator getKeys()
このバンドルと上位階層の全てのリソースキーの反復子を返却します。
この反復子は削除不可です。

定義:
インタフェース ResourceSet 内の getKeys
戻り値:
このバンドルと上位階層の全てのリソースキーの反復子

getObject

public java.lang.Object getObject(java.lang.Object key)
リソースキーが示す値を返却します。指定されたキーが存在しない場合 null を返却します。

定義:
インタフェース ResourceSet 内の getObject
パラメータ:
key - リソースキー
戻り値:
リソースキーが示す値
例外:
java.lang.NullPointerException - key が null の場合

getObject

public java.lang.Object getObject(java.lang.Object key,
                                  java.lang.Object defaultValue)
指定された文字列型のキーが示す値を返却します。
指定されたキーが存在しない場合 defaultValue を返却します。

定義:
インタフェース ResourceSet 内の getObject
パラメータ:
key - リソースキー
defaultValue - リソースキー
戻り値:
リソースキーが示す値
例外:
java.lang.NullPointerException - key が null の場合

containsKey

public boolean containsKey(java.lang.Object key)
指定されたキーがリソースセットに含まれている場合に true を返却します。
親の拡張リソースバンドルも検索対象とします。

定義:
インタフェース ResourceSet 内の containsKey
パラメータ:
key - リソースキー
戻り値:
指定されたキーが含まれている場合は true
例外:
java.lang.NullPointerException - key が null の場合

size

public int size()
インタフェース ResourceSet の記述:
リソースの数を返却します。

定義:
インタフェース ResourceSet 内の size
戻り値:
リソースの数

getMapView

public java.util.Map getMapView()
リソース集合のマップ表現を返却します。
親の拡張リソースバンドルの情報も含みます。

定義:
インタフェース ResourceSet 内の getMapView
戻り値:
リソース集合のマップ表現