XlsSaver (XlsMapper 2.0 API)

java.lang.Object
- com.gh.mygreen.xlsmapper.XlsSaver

```
public class XlsSaver
extends Object
```
JavaBeanをExcelのシートにマッピングし出力するクラス。

バージョン:

2.0

作成者:

T.TSUCHIE

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`XlsSaver()` デフォルトのコンストラクタ
`XlsSaver(Configuration configuration)` 独自のシステム情報を設定するコンストラクタ

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`Configuration`	`getConfiguration()` システム情報を取得します。
`void`	`save(InputStream templateXlsIn, OutputStream xlsOut, Object beanObj)` JavaのオブジェクトをExeclファイルに出力する。
`<P> SheetBindingErrors<P>`	`saveDetail(InputStream templateXlsIn, OutputStream xlsOut, P beanObj)` JavaのオブジェクトをExeclファイルに出力する。
`void`	`saveMultiple(InputStream templateXlsIn, OutputStream xlsOut, Object[] beanObjs)` 複数のオブジェクトをそれぞれのシートへ保存する。
`MultipleSheetBindingErrors<Object>`	`saveMultipleDetail(InputStream templateXlsIn, OutputStream xlsOut, Object[] beanObjs)` 複数のオブジェクトをそれぞれのシートへ保存する。
`void`	`setConfiguration(Configuration configuration)` システム情報を設定します。

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

- コンストラクタの詳細
  - XlsSaver
```
public XlsSaver(Configuration configuration)
```
    独自のシステム情報を設定するコンストラクタ
    
    パラメータ:
    
    configuration - システム情報
  - XlsSaver
```
public XlsSaver()
```
    デフォルトのコンストラクタ
- メソッドの詳細
  - save
```
public void save(InputStream templateXlsIn,
                 OutputStream xlsOut,
                 Object beanObj)
          throws XlsMapperException,
                 IOException
```
    JavaのオブジェクトをExeclファイルに出力する。
    出力するファイルは、引数で指定した雛形となるテンプレート用のExcelファイルをもとに出力する。
    
    パラメータ:
    
    templateXlsIn - 雛形となるExcelファイルの入力
    
    xlsOut - 出力先のストリーム
    
    beanObj - 書き込むBeanオブジェクト
    
    例外:
    
    IllegalArgumentException - templateXlsIn == null or xlsOut == null or beanObj == null
    
    XlsMapperException - マッピングに失敗した場合
    
    IOException - テンプレｰトのファイルの読み込みやファイルの出力に失敗した場合
  - saveDetail
```
public <P> SheetBindingErrors<P> saveDetail(InputStream templateXlsIn,
                                            OutputStream xlsOut,
                                            P beanObj)
                                     throws XlsMapperException,
                                            IOException
```
    JavaのオブジェクトをExeclファイルに出力する。
    出力するファイルは、引数で指定した雛形となるテンプレート用のExcelファイルをもとに出力する。
    
    型パラメータ:
    
    P - マッピング対象のクラスタイプ
    
    パラメータ:
    
    templateXlsIn - 雛形となるExcelファイルの入力
    
    xlsOut - 出力先のストリーム
    
    beanObj - 書き込むBeanオブジェクト
    
    戻り値:
    
    マッピング結果。 Configuration.isIgnoreSheetNotFound()の値がtrueで、シートが見つからない場合、nullを返します。
    
    例外:
    
    IllegalArgumentException - templateXlsIn == null or xlsOut == null or beanObj == null
    
    XlsMapperException - マッピングに失敗した場合
    
    IOException - テンプレｰトのファイルの読み込みやファイルの出力に失敗した場合
  - saveMultiple
```
public void saveMultiple(InputStream templateXlsIn,
                         OutputStream xlsOut,
                         Object[] beanObjs)
                  throws XlsMapperException,
                         IOException
```
    複数のオブジェクトをそれぞれのシートへ保存する。
    
    パラメータ:
    
    templateXlsIn - 雛形となるExcelファイルの入力
    
    xlsOut - xlsOut 出力先のストリーム
    
    beanObjs - 書き込むオブジェクトの配列。
    
    例外:
    
    IllegalArgumentException - templateXlsIn == null or xlsOut == null or beanObjs == null
    
    XlsMapperException - マッピングに失敗した場合
    
    IOException - テンプレｰトのファイルの読み込みやファイルの出力に失敗した場合
  - saveMultipleDetail
```
public MultipleSheetBindingErrors<Object> saveMultipleDetail(InputStream templateXlsIn,
                                                             OutputStream xlsOut,
                                                             Object[] beanObjs)
                                                      throws XlsMapperException,
                                                             IOException
```
    複数のオブジェクトをそれぞれのシートへ保存する。
    
    パラメータ:
    
    templateXlsIn - 雛形となるExcelファイルの入力
    
    xlsOut - xlsOut 出力先のストリーム
    
    beanObjs - 書き込むオブジェクトの配列。
    
    戻り値:
    
    マッピング結果。 Configuration.isIgnoreSheetNotFound()の値がtrueで、シートが見つからない場合、結果に含まれません。
    
    例外:
    
    IllegalArgumentException - templateXlsIn == null or xlsOut == null or beanObjs == null
    
    XlsMapperException - マッピングに失敗した場合
    
    IOException - テンプレｰトのファイルの読み込みやファイルの出力に失敗した場合
  - getConfiguration
```
public Configuration getConfiguration()
```
    システム情報を取得します。
    
    戻り値:
    
    現在のシステム情報
  - setConfiguration
```
public void setConfiguration(Configuration configuration)
```
    システム情報を設定します。
    
    パラメータ:
    
    configuration - システム情報

クラス XlsSaver

コンストラクタのサマリー

メソッドのサマリー

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

コンストラクタの詳細

XlsSaver

XlsSaver

メソッドの詳細

save

saveDetail

saveMultiple

saveMultipleDetail

getConfiguration

setConfiguration