shohaku.shoin
クラス Shoin

java.lang.Object
  拡張shohaku.shoin.Shoin

public class Shoin
extends java.lang.Object

プロキシを経由してリソース集合を生成する、松韻ライブラリの集約機能を提供します。
ファクトリやプロキシの各機能は独立して利用可能ですが、この機能を使用することで唯一のアクセスポイントからリソース集合の生成と管理を行えます。
またファクトリやプロキシの定義は構成ファイルに置かれるため、柔軟に構成を変更出来ます。

XML例:

 <shoin-context>
 
     <!-- 定数を定義できます。 -->
     <define>
         <type id="irs-type">shohaku.core.io.IOResource[]</type>
     </define>
 
     <!-- ResourceSetFactoryProxy の集合を定義します。 -->
     <proxys>
 
         <proxy id="xmlprops" class="shohaku.shoin.proxy.StaticResourceSetFactoryProxy">
             <property name="resourceSetFactory">
                 <object class="shohaku.shoin.factory.XMLProperties">
                     <property name="ioResources">
                         <array type="shohaku.core.io.IOResource[]">
                             <resource path="classpath:/test-xml-properties.xml" />
                         </array>
                     </property>
                 </object>
             </property>
         </proxy>
 
         <proxy id="constants" class="shohaku.shoin.proxy.StaticResourceSetFactoryProxy">
             <property name="resourceSetFactory">
                 <object class="shohaku.shoin.factory.ConstantsProperties">
                     <property name="sources">
                         <array type="Object[]">
                             <type>java.lang.Integer</type>
                             <type>java.lang.Long</type>
                         </array>
                     </property>
                     <property name="prefix">
                         <string>num:</string>
                     </property>
                     <property name="sourcesPrefix">
                         <array type="String[]">
                             <string>int:</string>
                             <string>long:</string>
                         </array>
                     </property>
                 </object>
             </property>
         </proxy>
 
     </proxys>
 
 </shoin-context>
 


フィールドの概要
static java.lang.String DEFAULT_CONFIG_PATH
          デフォルトの設定ファイルのパス (classpath:/shoin-context.xml)。
 
コンストラクタの概要
Shoin()
          デフォルトの設定でコンテキストを生成して初期化します。
Shoin(java.lang.ClassLoader classLoader)
          指定されたクラスローダとデフォルトのURLでコンテキストを生成して初期化します。
Shoin(java.lang.ClassLoader classLoader, java.lang.String url)
          指定されたクラスローダとURLでコンテキストを生成して初期化します。
 
メソッドの概要
 ResourceSet lookup(java.lang.String id)
          再生成を行わずに、識別子を持つリソース集合を返却します。
 ResourceSet lookup(java.lang.String id, boolean create)
          再生成を行うか指定して、識別子を持つリソース集合を返却します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

DEFAULT_CONFIG_PATH

public static final java.lang.String DEFAULT_CONFIG_PATH
デフォルトの設定ファイルのパス (classpath:/shoin-context.xml)。

関連項目:
定数フィールド値
コンストラクタの詳細

Shoin

public Shoin()
デフォルトの設定でコンテキストを生成して初期化します。

例外:
shohaku.core.lang.ConfigurationException - 構成情報の解析に失敗した場合

Shoin

public Shoin(java.lang.ClassLoader classLoader)
指定されたクラスローダとデフォルトのURLでコンテキストを生成して初期化します。

パラメータ:
classLoader - クラスローダ
例外:
shohaku.core.lang.ConfigurationException - 構成情報の解析に失敗した場合

Shoin

public Shoin(java.lang.ClassLoader classLoader,
             java.lang.String url)
指定されたクラスローダとURLでコンテキストを生成して初期化します。

パラメータ:
classLoader - クラスローダ
url - リソースURL
例外:
shohaku.core.lang.ConfigurationException - 構成情報の解析に失敗した場合
メソッドの詳細

lookup

public ResourceSet lookup(java.lang.String id)
                   throws ResourceSetCreationException
再生成を行わずに、識別子を持つリソース集合を返却します。
識別子が登録されていない場合は null が返却されます。

パラメータ:
id - 識別子
戻り値:
識別子を持つリソース集合
例外:
ResourceSetCreationException - リソース集合の生成に失敗した場合

lookup

public ResourceSet lookup(java.lang.String id,
                          boolean create)
                   throws ResourceSetCreationException
再生成を行うか指定して、識別子を持つリソース集合を返却します。
識別子が登録されていない場合は null が返却されます。

パラメータ:
id - 識別子
create - 再生成を要求する場合は true
戻り値:
識別子を持つリソース集合
例外:
ResourceSetCreationException - リソース集合の生成に失敗した場合