JavaTM 2 Platform
Standard Ed. 5.0

java.beans
クラス Encoder

java.lang.Object
  上位を拡張 java.beans.Encoder
直系の既知のサブクラス:
XMLEncoder

public class Encoder
extends Object

Encoder クラスは、公開 API を使って複数の JavaBeans の状態をエンコードするファイルまたはストリームを作成する際に使用されます。Encoder は、持続的な委譲とともに、オブジェクトグラフを一連の Statements とそれを作成する Expression に分解します。通常、サブクラスは、ユーザが読める書式、たとえば Java ソースコードや XML として、これらの式の構文を提供します。

導入されたバージョン:
1.4

コンストラクタの概要
Encoder()
           
 
メソッドの概要
 Object get(Object oldInstance)
          このストリームによって作成された、その環境における oldInstance の試験値を返します。
 ExceptionListener getExceptionListener()
          このストリームの例外ハンドラを取得します。
 PersistenceDelegate getPersistenceDelegate(Class<?> type)
          指定された型の持続的な委譲を返します。
 Object remove(Object oldInstance)
          このインスタンスのエントリを削除し、古いエントリを返します。
 void setExceptionListener(ExceptionListener exceptionListener)
          このストリームの例外ハンドラを exceptionListener とします。
 void setPersistenceDelegate(Class<?> type, PersistenceDelegate persistenceDelegate)
          この type の持続的な委譲を persistenceDelegate にします。
 void writeExpression(Expression oldExp)
          実装は、最初に、この値を持つ式がすでに書き込まれているかどうかを確認します。
protected  void writeObject(Object o)
          指定されたオブジェクトを出力ストリームに書き込みます。
 void writeStatement(Statement oldStm)
          ストリームに oldStm 文を書き込みます。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

Encoder

public Encoder()
メソッドの詳細

writeObject

protected void writeObject(Object o)
指定されたオブジェクトを出力ストリームに書き込みます。直列化された書式は、一連の式を示します。式の組み合わせの結果、入力ストリームの読み込み時に等価のオブジェクトが作成されます。デフォルトでは、オブジェクトは nullary のコンストラクタ (その状態は Introspector が返す set メソッドと get メソッドの照合によって定義される) を持つ JavaBean になります。

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

setExceptionListener

public void setExceptionListener(ExceptionListener exceptionListener)
このストリームの例外ハンドラを exceptionListener とします。このストリームが回復可能な例外をキャッチすると、この例外ハンドラに通知されます。

パラメータ:
exceptionListener - このストリームの例外ハンドラ。null の場合、デフォルトの例外リスナーが使用される
関連項目:
getExceptionListener()

getExceptionListener

public ExceptionListener getExceptionListener()
このストリームの例外ハンドラを取得します。

戻り値:
このストリームの例外ハンドラ。明示的に設定されていない場合は、デフォルトの例外リスナーが返される
関連項目:
setExceptionListener(java.beans.ExceptionListener)

getPersistenceDelegate

public PersistenceDelegate getPersistenceDelegate(Class<?> type)
指定された型の持続的な委譲を返します。持続的な委譲は、次の規則を正しく適用することによって計算されます。

パラメータ:
type - オブジェクトの型
戻り値:
このオブジェクト型の持続的な委譲
関連項目:
setPersistenceDelegate(java.lang.Class, java.beans.PersistenceDelegate), Introspector.getBeanInfo(java.lang.Class), BeanInfo.getBeanDescriptor()

setPersistenceDelegate

public void setPersistenceDelegate(Class<?> type,
                                   PersistenceDelegate persistenceDelegate)
この type の持続的な委譲を persistenceDelegate にします。

パラメータ:
type - persistenceDelegate が適用されるオブジェクトのクラス
persistenceDelegate - type のインスタンスの持続的な委譲
関連項目:
getPersistenceDelegate(java.lang.Class), Introspector.getBeanInfo(java.lang.Class), BeanInfo.getBeanDescriptor()

remove

public Object remove(Object oldInstance)
このインスタンスのエントリを削除し、古いエントリを返します。

パラメータ:
oldInstance - 削除されるエントリ
戻り値:
削除されたエントリ
関連項目:
get(java.lang.Object)

get

public Object get(Object oldInstance)
このストリームによって作成された、その環境における oldInstance の試験値を返します。持続的な委譲は、この値の初期化によって出力時に等価オブジェクトを作成するのか、あるいは新しいオブジェクトをインスタンス化する必要があるのかどうかを、mutatesTo メソッドを使って判断します。この値がストリームにとって未知の値である場合、戻り値は null になります。

パラメータ:
oldInstance - 検索されるインスタンス
戻り値:
未知のオブジェクトの場合 null

writeStatement

public void writeStatement(Statement oldStm)
ストリームに oldStm 文を書き込みます。oldStm は、完全に呼び出し元の環境で書き込まれる必要があります。これは、ターゲットとすべての引数が、書き込まれるオブジェクトグラフの一部になっていなければならないということです。これらの式は、何が起こったかを示す一連の式、すなわち、出力ストリームにオリジナルと同様のオブジェクトグラフを生成する方法を示す式になります。

このメソッドを実装すると、ストリームの読み込み時にその環境内の式となる、2 番目の式が生成されます。この式を取得するには、ターゲット上の writeObject とすべての引数を呼び出し、その結果を使って新しい式を構築します。

パラメータ:
oldStm - ストリームに書き込まれる式

writeExpression

public void writeExpression(Expression oldExp)
実装は、最初に、この値を持つ式がすでに書き込まれているかどうかを確認します。書き込まれていない場合は、writeStatement と同様の手順で式が複製され、writeObject の呼び出しにより、複製された式の値とこの式の値が照合されます。

パラメータ:
oldExp - ストリームに書き込まれる式

JavaTM 2 Platform
Standard Ed. 5.0

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java 2 SDK SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。