shohaku.shoin
インタフェース ResourceSet

既知の実装クラスの一覧:
CompositeResourceSet, MapResourceSet, MultiTypeResourceSet, XResourceBundle

public interface ResourceSet

識別子で対応づけられるリソースの集合を表現する機能を提供します。


メソッドの概要
 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()
          リソースの数を返却します。
 

メソッドの詳細

getKeys

public java.util.Iterator getKeys()
全てのリソースキーの変更不可の反復子を返却します。

戻り値:
全てのリソースキーの反復子

getObject

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

パラメータ:
key - キー
戻り値:
キーが示す値
例外:
ResourceCreationException - リソース生成に失敗した場合
java.lang.NullPointerException - key が null の場合

getObject

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

パラメータ:
key - キー
defaultValue - デフォルト値
戻り値:
キーが示す値
例外:
ResourceCreationException - リソース生成に失敗した場合
java.lang.NullPointerException - key が null の場合

containsKey

public boolean containsKey(java.lang.Object key)
指定されたキーがリソースに含まれている場合に true を返却します。

パラメータ:
key - キー
戻り値:
指定されたキーが含まれている場合は true
例外:
java.lang.NullPointerException - key が null の場合

size

public int size()
リソースの数を返却します。

戻り値:
リソースの数

getMapView

public java.util.Map getMapView()
リソース集合の変更不可能なマップ表現を返却します。

戻り値:
リソース集合のマップ表現