ConfigurationLoader (javadoc-all-dev 8.0.0 API)

java.lang.Object
- jp.co.intra_mart.foundation.config.ConfigurationLoader

```
public final class ConfigurationLoader
extends Object
```
設定ファイルの読み込みを管理する機能を提供します.

バージョン:

8.0

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

static String SUFFIX_KEY
リソース検索時のsuffixを指定するためのキーです.

フィールド
修飾子とタイプ	フィールドと説明
`static String`	`SUFFIX_KEY` リソース検索時のsuffixを指定するためのキーです.

メソッドのサマリー

すべてのメソッド staticメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`static void`	`clearCache(Class<?> configurationClass)` 内部に保持している設定のクリアを行ないます.
`static <T> Schema`	`findSchema(Class<T> configurationClass)` 設定クラスに対応したスキーマを取得します.
`static <T> Schema`	`findSchema(Class<T> configurationClass, ClassLoader classLoader)` 設定クラスに対応したスキーマを取得します.
`static <T> T`	`load(Class<T> configurationClass)` 設定の読込みを行ないます.
`static <T> T`	`load(Class<T> configurationClass, ClassLoader classLoader)` 設定の読込みを行ないます.
`static <T> T`	`load(Class<T> configurationClass, Instance instance)` 設定の読込みを行ないます.
`static <T> T`	`load(Class<T> configurationClass, Instance instance, ClassLoader classLoader)` 設定の読込みを行ないます.
`static <T> Collection<T>`	`loadAll(Class<T> configurationClass)` 設定の読込みを行ないます.
`static <T> Collection<T>`	`loadAll(Class<T> configurationClass, ClassLoader classLoader)` 設定の読込みを行ないます.
`static <T> Collection<T>`	`loadAll(Class<T> configurationClass, Instance instance)` 設定の読込みを行ないます.
`static <T> Collection<T>`	`loadAll(Class<T> configurationClass, Instance instance, ClassLoader classLoader)` 設定の読込みを行ないます.
`static <T> void`	`save(T configuration)` 設定の保存を行います.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - SUFFIX_KEY
```
public static final String SUFFIX_KEY
```
    リソース検索時のsuffixを指定するためのキーです.
- メソッドの詳細
  - clearCache
```
public static void clearCache(Class<?> configurationClass)
                       throws ConfigurationException
```
    内部に保持している設定のクリアを行ないます. このメソッドを呼び出した場合、クラスタに含まれるノードが持つ設定のクリアが行われます.
    
    パラメータ:
    
    configurationClass - 設定クラス
    
    例外:
    
    ConfigurationException - 設定のクリアに失敗した場合に通知されます
  - findSchema
```
public static <T> Schema findSchema(Class<T> configurationClass)
                             throws ConfigurationException
```
    設定クラスに対応したスキーマを取得します. スキーマが存在しない場合はnullが返却されます
    
    型パラメータ:
    
    T - 設定クラスパラメータ
    
    パラメータ:
    
    configurationClass - 設定クラス
    
    戻り値:
    
    スキーマ
    
    例外:
    
    ConfigurationException - スキーマの取得に失敗した場合に通知されます
  - findSchema
```
public static <T> Schema findSchema(Class<T> configurationClass,
                                    ClassLoader classLoader)
                             throws ConfigurationException
```
    設定クラスに対応したスキーマを取得します. スキーマが存在しない場合はSchemaNotFoundExceptionがthrowされます.
    
    型パラメータ:
    
    T - 設定クラスパラメータ
    
    パラメータ:
    
    configurationClass - 設定クラス
    
    classLoader - スキーマの検索を行うクラスローダ
    
    戻り値:
    
    スキーマ
    
    例外:
    
    ConfigurationException - スキーマの取得に失敗した場合に通知されます
  - load
```
public static <T> T load(Class<T> configurationClass)
                  throws ConfigurationException
```
    設定の読込みを行ないます. このメソッドにより読み込まれたインスタンスはclearCache(Class) メソッドによりクリアされない限り同一インスタンスが返却されます.
    
    型パラメータ:
    
    T - 設定クラスタイプ
    
    パラメータ:
    
    configurationClass - 設定クラス
    
    戻り値:
    
    設定が読み込まれたインスタンス
    
    例外:
    
    ConfigurationException - 設定の読込みに失敗した場合に通知されます
  - save
```
public static <T> void save(T configuration)
                     throws ConfigurationException
```
    設定の保存を行います. このメソッドを呼び出した場合、引数configurationに指定された内容の永続化を行います.
    このメソッドでは、内部で管理されている読み込み済みの設定のクリアは行いません.
    保存と同時に、設定の読み直しを行いたい場合は、このメソッドを呼び出した後に、clearCache(Class)を呼び出してください.
    
    型パラメータ:
    
    T - 設定クラスタイプ
    
    パラメータ:
    
    configuration - 設定インスタンス.
    
    例外:
    
    ConfigurationException - 設定ファイルの保存に失敗した場合に通知されます.
  - load
```
public static <T> T load(Class<T> configurationClass,
                         ClassLoader classLoader)
                  throws ConfigurationException
```
    設定の読込みを行ないます. このメソッドにより読み込まれたインスタンスはclearCache(Class) メソッドによりクリアされない限り同一インスタンスが返却されます.
    
    型パラメータ:
    
    T - 設定クラスタイプ
    
    パラメータ:
    
    configurationClass - 設定クラス
    
    classLoader - 設定の検索を行うクラスローダ
    
    戻り値:
    
    設定が読み込まれたインスタンス
    
    例外:
    
    ConfigurationException - 設定の読込みに失敗した場合に通知されます
  - load
```
public static <T> T load(Class<T> configurationClass,
                         Instance instance)
                  throws ConfigurationException
```
    設定の読込みを行ないます.
    
    型パラメータ:
    
    T - 設定クラスタイプ
    
    パラメータ:
    
    configurationClass - 設定クラス
    
    instance - インスタンス管理
    
    戻り値:
    
    設定が読み込まれたインスタンス
    
    例外:
    
    ConfigurationException - 設定の読込みに失敗した場合に通知されます
  - load
```
public static <T> T load(Class<T> configurationClass,
                         Instance instance,
                         ClassLoader classLoader)
                  throws ConfigurationException
```
    設定の読込みを行ないます.
    
    型パラメータ:
    
    T - 設定クラスタイプ
    
    パラメータ:
    
    configurationClass - 設定クラス
    
    instance - インスタンス管理
    
    classLoader - 設定の検索を行うクラスローダ
    
    戻り値:
    
    設定が読み込まれたインスタンス
    
    例外:
    
    ConfigurationException - 設定の読込みに失敗した場合に通知されます
  - loadAll
```
public static <T> Collection<T> loadAll(Class<T> configurationClass)
                                 throws ConfigurationException
```
    設定の読込みを行ないます. このメソッドにより読み込まれたインスタンスはclearCache(Class) メソッドによりクリアされない限り同一インスタンスが返却されます.
    
    型パラメータ:
    
    T - 設定クラスタイプ
    
    パラメータ:
    
    configurationClass - 設定クラス
    
    戻り値:
    
    設定が読み込まれたインスタンス
    
    例外:
    
    ConfigurationException - 設定の読込みに失敗した場合に通知されます
  - loadAll
```
public static <T> Collection<T> loadAll(Class<T> configurationClass,
                                        ClassLoader classLoader)
                                 throws ConfigurationException
```
    設定の読込みを行ないます. このメソッドにより読み込まれたインスタンスはclearCache(Class) メソッドによりクリアされない限り同一インスタンスが返却されます.
    
    型パラメータ:
    
    T - 設定クラスタイプ
    
    パラメータ:
    
    configurationClass - 設定クラス
    
    classLoader - 設定の検索を行うクラスローダ
    
    戻り値:
    
    設定が読み込まれたインスタンス
    
    例外:
    
    ConfigurationException - 設定の読込みに失敗した場合に通知されます
  - loadAll
```
public static <T> Collection<T> loadAll(Class<T> configurationClass,
                                        Instance instance)
                                 throws ConfigurationException
```
    設定の読込みを行ないます.
    
    型パラメータ:
    
    T - 設定クラスタイプ
    
    パラメータ:
    
    configurationClass - 設定クラス
    
    instance - インスタンス管理
    
    戻り値:
    
    設定が読み込まれたインスタンス
    
    例外:
    
    ConfigurationException - 設定の読込みに失敗した場合に通知されます
  - loadAll
```
public static <T> Collection<T> loadAll(Class<T> configurationClass,
                                        Instance instance,
                                        ClassLoader classLoader)
                                 throws ConfigurationException
```
    設定の読込みを行ないます.
    
    型パラメータ:
    
    T - 設定クラスタイプ
    
    パラメータ:
    
    configurationClass - 設定クラス
    
    instance - インスタンス管理
    
    classLoader - 設定の検索を行うクラスローダ
    
    戻り値:
    
    設定が読み込まれたインスタンス
    
    例外:
    
    ConfigurationException - 設定の読込みに失敗した場合に通知されます

クラス ConfigurationLoader

フィールドのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

SUFFIX_KEY

メソッドの詳細

clearCache

findSchema

findSchema

load

save

load

load

load

loadAll

loadAll

loadAll

loadAll