XMLEncoder (Java 2 Platform SE 5.0)

概要

パッケージ

クラス

使用

階層ツリー

非推奨 API

索引

ヘルプ

Java^TM 2 Platform
Standard Ed. 5.0

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

java.beans
クラス XMLEncoder

java.lang.Object
  java.beans.Encoder
      java.beans.XMLEncoder

public class XMLEncoder
extends Encoder
extends Encoder

XMLEncoder クラスは ObjectOutputStream の補足的な代替クラスであり、ObjectOutputStream で Serializable オブジェクトのバイナリ表現を生成する場合と同じ方法で JavaBean のテキスト表現を生成します。たとえば、次のコードでは、提供された JavaBean とそのすべてのプロパティのテキスト表現を生成できます。


       XMLEncoder e = new XMLEncoder(
                          new BufferedOutputStream(
                              new FileOutputStream("Test.xml")));
       e.writeObject(new JButton("Hello, world"));
       e.close();

API は似ているものの、XMLEncoder クラスは、JavaBean のグラフをその公開プロパティのテキスト表現としてアーカイブ化する目的で設計されています。この方式で作成された文書は、Java ソースファイルと同様、必要なクラスの実装が変更から保護されています。プロセス間通信および通常目的の直列化には、これまでどおり ObjectOutputStream を使用することをお勧めします。

XMLEncoder クラスは、JavaBean を、XML 仕様バージョン 1.0 と Unicode/ISO 10646 文字セットの UTF-8 文字セットに準拠した XML 文書として表現するデフォルトの指定を提供します。XMLEncoder クラスによって生成される XML 文書には、次のような特徴があります。

移植性とバージョンの違いに対する許容性: クラスの非公開実装には一切依存しないため、Java ソースファイルと同様に、一部のクラスのバージョンが異なる複数の環境間、あるいはベンダーの異なる VM 間で交換可能
コンパクトな構造: XMLEncoder クラスは内部で冗長性削減アルゴリズムを使用するため、Bean のプロパティのデフォルト値がストリームに書き込まれない
障害許容性: ファイルが壊れたり、ローカライズされたアーカイブ内のクラスの API が変更されたりして、ファイル内に非構造上のエラーが生じても、エラーを報告し、文書内のエラーの影響を受けていない部分をロードし続けることができる

以下は、swing ツールキットのユーザインタフェースコンポーネントを含む XML アーカイブの例です。


 <?xml version="1.0" encoding="UTF-8"?>
 <java version="1.0" class="java.beans.XMLDecoder">
 <object class="javax.swing.JFrame">
   <void property="name">
     <string>frame1</string>
   </void>
   <void property="bounds">
     <object class="java.awt.Rectangle">
       <int>0</int>
       <int>0</int>
       <int>200</int>
       <int>200</int>
     </object>
   </void>
   <void property="contentPane">
     <void method="add">
       <object class="javax.swing.JButton">
         <void property="label">
           <string>Hello</string>
         </void>
       </object>
     </void>
   </void>
   <void property="visible">
     <boolean>true</boolean>
   </void>
 </object>
 </java>

XML 構文は、次の規約に準拠しています。

個々の要素はメソッド呼び出しを表す
object タグは、囲む要素の引数として使用される値を持つ式を表す
void タグは、実行されるだけで、その結果は囲むメソッドの引数として使用されない文を表す
ほかの要素を包含する要素は、これらの要素を引数として使用する。ただし、包含されている要素に void タグが含まれていない場合に限る
メソッド名は method 属性によって表される
XML の標準属性である id および idref を使って以前の式を参照し、オブジェクトグラフの循環を処理する
class 属性を使って静的メソッドまたはコンストラクタのターゲットを明示的に指定する。その値は完全指定のクラス名になる
void タグ付きの要素は、class 属性によってターゲットが定義されていない場合、外部コンテキストをターゲットとして実行される
Java の String クラスは、特別なものとして、<string>Hello, world</string> に書き込まれる。ここで、文字列に含まれる文字は、UTF-8 文字セットによりバイトに変換される

すべてのオブジェクトグラフはこれら 3 つのタグで記述できますが、共通のデータ構造をより簡潔に表現するため、次の定義がなされています。

デフォルトのメソッド名は new
java クラスの参照は、<class>javax.swing.JButton</class> という形式で記述する
Java プリミティブ型のラッパークラスのインスタンスは、プリミティブ型の名前をタグとして記述される。たとえば、Integer クラスのインスタンスは <int>123</int> と記述できる。XMLEncoder クラスが、Java プリミティブ型と関連ラッパークラス間の変換を内部的に処理する Java リフレクションパッケージを使用する点に注意すること。XMLEncoder クラスの API 自体は、Object だけを取り扱う
名前の先頭の文字列が get で始まるような nullary のメソッドを表現する要素では、method 属性は property 属性で置き換えられる。なお、property 属性の値は、get 接頭辞を削除し、メソッド名の先頭の文字をアルファベットの小文字に変更することによって得られる
名前の先頭の文字列が set で始まるような単一のメソッドを表現する要素では、method 属性は property 属性で置き換えられる。なお、property 属性の値は、set 接頭辞を削除し、メソッド名の先頭の文字をアルファベットの小文字に変更することによって得られる
get メソッドとして指定され、整数の引数を 1 つとるようなメソッドを表現する要素では、method 属性は index 属性で置き換えられる。なお、index 属性の値は最初の引数の値と同じになる
set メソッドとして指定され、引数を 2 つとるようなメソッドを表現する要素では、method 属性は index 属性で置き換えられる。なお、index 属性の値は、最初の引数の値と同じになる
配列の参照は、array タグによって記述される。class 属性はその配列のサブタイプ、length 属性はその配列の長さを指定する

詳細については、『The Swing Connection』の記事「Using XMLEncoder」を参照してください。

導入されたバージョン:: 1.4
関連項目:: XMLDecoder, ObjectOutputStream

コンストラクタの概要
`XMLEncoder(OutputStream out)` XML エンコーディングを使ってストリーム `out` に JavaBeans を送信する、新しい出力ストリームを作成します。

メソッドの概要
`void`	`close()` このメソッドは、`flush` を呼び出し、閉じるポストアンブルを書き込み、このストリームに関連付けられている出力ストリームをクローズします。
`void`	`flush()` このメソッドは、XML エンコーディングに関連付けられたプリアンブルを書き出し、`flush` を最後に呼び出したときからストリームに書き込まれたすべての値を書き出します。
`Object`	`getOwner()` このエンコーダの所有者を取得します。
`void`	`setOwner(Object owner)` このエンコーダの所有者を `owner` に設定します。
`void`	`writeExpression(Expression oldExp)` ストリームのフラッシュ時に Encoder が実際の出力を生成するように、Expression を記録します。
`void`	`writeObject(Object o)` 指定されたオブジェクトの XML 表現を出力に書き込みます。
`void`	`writeStatement(Statement oldStm)` ストリームのフラッシュ時に Encoder が実際の出力を生成するように、Statement を記録します。

クラス java.beans.Encoder から継承されたメソッド
`get, getExceptionListener, getPersistenceDelegate, remove, setExceptionListener, setPersistenceDelegate`

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

コンストラクタの詳細

XMLEncoder

public XMLEncoder(OutputStream out)

XML エンコーディングを使ってストリーム out に JavaBeans を送信する、新しい出力ストリームを作成します。

パラメータ:: out - オブジェクトの XML 表現の送信先となるストリーム
関連項目:: XMLDecoder.XMLDecoder(InputStream)

メソッドの詳細

setOwner

public void setOwner(Object owner)

このエンコーダの所有者を owner に設定します。

パラメータ:: owner - このエンコーダの所有者
関連項目:: getOwner()

getOwner

public Object getOwner()

このエンコーダの所有者を取得します。

戻り値:: このエンコーダの所有者
関連項目:: setOwner(java.lang.Object)

writeObject

public void writeObject(Object o)

指定されたオブジェクトの XML 表現を出力に書き込みます。

オーバーライド:: クラス Encoder 内の writeObject

パラメータ:: o - ストリームに書き込まれるオブジェクト
関連項目:: XMLDecoder.readObject()

writeStatement

public void writeStatement(Statement oldStm)

ストリームのフラッシュ時に Encoder が実際の出力を生成するように、Statement を記録します。

このメソッドは、持続性デリゲートの初期化コンテキスト以外では呼び出しません。

オーバーライド:: クラス Encoder 内の writeStatement

パラメータ:: oldStm - ストリームに書き込まれる文
関連項目:: PersistenceDelegate.initialize(java.lang.Class, java.lang.Object, java.lang.Object, java.beans.Encoder)

writeExpression

public void writeExpression(Expression oldExp)

ストリームのフラッシュ時に Encoder が実際の出力を生成するように、Expression を記録します。

このメソッドは、持続性デリゲートの初期化時、またはリソースバンドルから読み取れるようにエンコーダを設定しているとき以外は呼び出せません。

XMLEncoder でリソースバンドルを使用する方法については、http://java.sun.com/products/jfc/tsc/articles/persistence4/#i18n を参照してください。

オーバーライド:: クラス Encoder 内の writeExpression

パラメータ:: oldExp - ストリームに書き込まれる式
関連項目:: PersistenceDelegate.initialize(java.lang.Class, java.lang.Object, java.lang.Object, java.beans.Encoder)

flush

public void flush()

このメソッドは、XML エンコーディングに関連付けられたプリアンブルを書き出し、flush を最後に呼び出したときからストリームに書き込まれたすべての値を書き出します。フラッシュ後、このストリームに書き込まれた値の内部参照はすべてクリアされます。

close

public void close()

このメソッドは、flush を呼び出し、閉じるポストアンブルを書き込み、このストリームに関連付けられている出力ストリームをクローズします。

概要