XMLContentsWriter (javadoc-all-dev 8.0.0 API)

java.lang.Object
- jp.co.intra_mart.foundation.data.util.XMLContentsWriter<T>

型パラメータ:

T - XMLに変換するJavaオブジェクトのクラス型

すべての実装されたインタフェース:

Closeable, AutoCloseable
```
public class XMLContentsWriter<T>
extends Object
implements Closeable
```
XMLを出力するためのWriterクラスです。
このWriterは大量データを書きこむ際に利用します。
このWriterでは、JAXB バインディングフレームワークを利用して整列化および検証を行ないます。
コンストラクタ生成時には、JAXBContext によって認識される Java クラスを指定してください。

バージョン:

8.0

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

コンストラクタ
コンストラクタと説明
`XMLContentsWriter(OutputStream stream, Class<T> classToBeBound)` デフォルトエンコーディング'(UTF-8)で出力ストリームに書きこむXMLContentsWriterを生成します。
`XMLContentsWriter(OutputStream stream, Class<T> classToBeBound, Map<String,Object> option)` エクスポートオプションの設定を利用して出力ストリームに書きこみを行うXMLContentsReaderを生成します。
`XMLContentsWriter(OutputStream stream, Class<T> classToBeBound, String encoding)` 指定されたエンコーディング'で出力ストリームに書きこむXMLContentsWriterを生成します。
`XMLContentsWriter(OutputStream stream, Class<T> classToBeBound, String encoding, boolean formatXml)` 指定されたエンコーディング'で出力ストリームに書きこむXMLContentsWriterを生成します。
`XMLContentsWriter(OutputStream stream, Class<T> classToBeBound, String encoding, boolean formatXml, boolean validateXml)` 指定されたエンコーディング'で出力ストリームに書きこむXMLContentsWriterを生成します。
`XMLContentsWriter(OutputStream stream, Class<T> classToBeBound, String encoding, boolean formatXml, boolean validateXml, String rootTagName)` 指定されたエンコーディング'で出力ストリームに書きこむXMLContentsWriterを生成します。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`close()`
`void`	`flush()` ストリームをフラッシュします。
`void`	`write(T content)` 指定された要素を出力ストリームに書き込みます。

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

- コンストラクタの詳細
  - XMLContentsWriter
```
public XMLContentsWriter(OutputStream stream,
                         Class<T> classToBeBound)
                  throws XMLContentsWriterException
```
    デフォルトエンコーディング'(UTF-8)で出力ストリームに書きこむXMLContentsWriterを生成します。
    ストリームに書きこむ際にはスキーマバリデーションを行ないます。
    
    パラメータ:
    
    stream - 出力ストリーム
    
    classToBeBound - バインドクラス
    
    例外:
    
    XMLContentsWriterException - スキーマの取得に失敗した場合等、書き込みができない場合にスローされます。
  - XMLContentsWriter
```
public XMLContentsWriter(OutputStream stream,
                         Class<T> classToBeBound,
                         Map<String,Object> option)
                  throws XMLContentsWriterException
```
    エクスポートオプションの設定を利用して出力ストリームに書きこみを行うXMLContentsReaderを生成します。
    このコンストラクタはエクスポートオプションからエンコーディング等のパラメータを取得し設定を行ないます。
    
    パラメータ:
    
    stream - 出力ストリーム
    
    classToBeBound - バインドクラス
    
    option - エクスポートオプション
    
    例外:
    
    XMLContentsWriterException - スキーマの取得に失敗した場合等、書き込みができない場合にスローされます。
  - XMLContentsWriter
```
public XMLContentsWriter(OutputStream stream,
                         Class<T> classToBeBound,
                         String encoding)
                  throws XMLContentsWriterException
```
    指定されたエンコーディング'で出力ストリームに書きこむXMLContentsWriterを生成します。
    ストリームに書きこむ際にはスキーマバリデーションを行ないます。
    
    パラメータ:
    
    stream - 出力ストリーム
    
    classToBeBound - バインドクラス
    
    encoding - エンコーディング
    
    例外:
    
    XMLContentsWriterException - スキーマの取得に失敗した場合等、書き込みができない場合にスローされます。
  - XMLContentsWriter
```
public XMLContentsWriter(OutputStream stream,
                         Class<T> classToBeBound,
                         String encoding,
                         boolean formatXml)
                  throws XMLContentsWriterException
```
    指定されたエンコーディング'で出力ストリームに書きこむXMLContentsWriterを生成します。
    ストリームに書きこむ際にはスキーマバリデーションを行ないます。
    このコンストラクタではXMLのフォーマットを行うかどうかを指定できます。
    
    パラメータ:
    
    stream - 出力ストリーム
    
    classToBeBound - バインドクラス
    
    encoding - エンコーディング
    
    formatXml - XMLのフォーマットを行うかどうか
    
    例外:
    
    XMLContentsWriterException - スキーマの取得に失敗した場合等、書き込みができない場合にスローされます。
  - XMLContentsWriter
```
public XMLContentsWriter(OutputStream stream,
                         Class<T> classToBeBound,
                         String encoding,
                         boolean formatXml,
                         boolean validateXml)
                  throws XMLContentsWriterException
```
    指定されたエンコーディング'で出力ストリームに書きこむXMLContentsWriterを生成します。
    このコンストラクタでは、スキーマバリデーションを行うかどうかを指定できます。
    
    パラメータ:
    
    stream - 出力ストリーム
    
    classToBeBound - バインドクラス
    
    encoding - エンコーディング
    
    formatXml - XMLのフォーマットを行うかどうか
    
    validateXml - スキーマバリデーションを行うかどうか
    
    例外:
    
    XMLContentsWriterException - スキーマの取得に失敗した場合等、書き込みができない場合にスローされます。
  - XMLContentsWriter
```
public XMLContentsWriter(OutputStream stream,
                         Class<T> classToBeBound,
                         String encoding,
                         boolean formatXml,
                         boolean validateXml,
                         String rootTagName)
                  throws XMLContentsWriterException
```
    指定されたエンコーディング'で出力ストリームに書きこむXMLContentsWriterを生成します。
    このコンストラクタでは、ルートノード名を指定できます。
    
    パラメータ:
    
    stream - 出力ストリーム
    
    classToBeBound - バインドクラス
    
    encoding - エンコーディング
    
    formatXml - XMLのフォーマットを行うかどうか
    
    validateXml - スキーマバリデーションを行うかどうか
    
    rootTagName - ルートタグ名
    
    例外:
    
    XMLContentsWriterException - スキーマの取得に失敗した場合等、書き込みができない場合にスローされます。
- メソッドの詳細
  - close
```
public void close()
```
    定義:
    
    close インタフェース内 Closeable
    
    定義:
    
    close インタフェース内 AutoCloseable
  - flush
```
public void flush()
```
    ストリームをフラッシュします。
  - write
```
public void write(T content)
           throws XMLContentsWriterException
```
    指定された要素を出力ストリームに書き込みます。
    
    パラメータ:
    
    content - 要素
    
    例外:
    
    XMLContentsWriterException - 要素の書き込みに失敗した場合にスローされます。

クラス XMLContentsWriter<T>

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

メソッドのサマリー

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

コンストラクタの詳細

XMLContentsWriter

XMLContentsWriter

XMLContentsWriter

XMLContentsWriter

XMLContentsWriter

XMLContentsWriter

メソッドの詳細

close

flush

write