javax.print

クラスSimpleDoc

java.lang.Object

javax.print.SimpleDoc

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

Doc

public final class SimpleDoc
extends Object
implements Doc

このクラスは、一般的な多くの印刷要求で使用可能なDocインタフェースの実装です。このクラスは、現在、DocFlavorクラス内のstatic変数として「事前定義」されているすべてのdocフレーバを処理可能です。

特に、このクラスは、要求された特定のDoc仕様セマンティックスを、次の方法で実装します。

• 要求されていて適切な場合に、サービス用のストリームを構築する
• メソッドに対する各呼出しで、同じオブジェクトが返されるようにする
• 複数のスレッドからDocへのアクセス可能にする
• データとdocフレーバの一致確認をいくつか実行する

ほかのジョブでdocオブジェクトを再利用するか、MultiDocを必要とするクライアントは、このクラスを使用しません。

印刷データがストリームの場合、または印刷ジョブがデータをストリームとして要求する場合、SimpleDocは、データ転送やジョブの完了後にサービスがストリームを適切に閉じるかどうかを監視しません。クライアントは、リスナーを追加する独自のdoc実装を提供して、ジョブの完了を監視したり、ストリームなどのリソースの解放(クローズ)を確認することもできます。

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

コンストラクタ

コンストラクタと説明
SimpleDoc(Object printData, DocFlavor flavor, DocAttributeSet attributes) 指定された印刷データ、docフレーバ、およびdoc属性セットを使用して、SimpleDocを構築します。

メソッドのサマリー

修飾子と型	メソッドと説明
DocAttributeSet	getAttributes() このdocオブジェクトの印刷属性セットを取得します。
DocFlavor	getDocFlavor() このdocオブジェクトが印刷データの一部を提供するdocフレーバを判別します。
Object	getPrintData() このdocオブジェクトの印刷データの一部を含む印刷データ表現オブジェクトを、サポートするdocフレーバに対応する形式で取得します。
Reader	getReaderForText() このdocから文字印刷データを抽出するためのリーダーを取得します。
InputStream	getStreamForBytes() このdocからバイト印刷データを抽出するための入力ストリームを取得します。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

SimpleDoc

public SimpleDoc(Object printData,
                 DocFlavor flavor,
                 DocAttributeSet attributes)

指定された印刷データ、docフレーバ、およびdoc属性セットを使用して、SimpleDocを構築します。

パラメータ:

printData - 印刷データ・オブジェクト。

flavor - DocFlavorオブジェクト

attributes - DocAttributeSet (nullの場合あり)

例外:

IllegalArgumentException - flavorまたはprintDataがnullであるか、printDataが指定されたdocフレーバに対応していない場合(たとえば、データがDocFlavor内の表現として指定された型ではない場合)。

メソッドの詳細

getDocFlavor

public DocFlavor getDocFlavor()

このdocオブジェクトが印刷データの一部を提供するdocフレーバを判別します。

定義:

getDocFlavor、インタフェース: Doc

戻り値:

Docフレーバ

getAttributes

public DocAttributeSet getAttributes()

このdocオブジェクトの印刷属性セットを取得します。返される属性セットに特定の属性Xのインスタンスが含まれる場合、プリンタはその属性値をこのdocに使用して、ジョブの属性セット内の属性Xの値をすべてオーバーライドする必要があります。返される属性セットに特定の属性Xのインスタンスが含まれない場合、またはnullが返される場合、プリンタはジョブの属性セットを参照して属性Xの値を取得する必要があります。見つからない場合、プリンタは実装依存のデフォルト値を使用する必要があります。返された属性セットは変更できません。

定義:

getAttributes、インタフェース: Doc

戻り値:

このdocの変更不可能な印刷属性セット。または、ジョブの属性セットからすべての属性値を取得する場合はnull

getPrintData

public Object getPrintData()
                    throws IOException

インタフェースからコピーされた説明: Doc

このdocオブジェクトの印刷データの一部を含む印刷データ表現オブジェクトを、サポートするdocフレーバに対応する形式で取得します。getPrintData()メソッドは、名前がgetDocFlavor().getRepresentationClassName()で与えられる表現クラスのインスタンスを返します。戻り値は、クラスObjectから表現クラスにキャストできます。

定義:

getPrintData、インタフェース: Doc

戻り値:

印刷データ表現オブジェクト

例外:

IOException - 表現クラスがストリームであり、そのストリームの構成中に入出力エラーが発生した場合にスローされる。

getReaderForText

public Reader getReaderForText()
                        throws IOException

このdocから文字印刷データを抽出するためのリーダーを取得します。DocFlavorが次の印刷データ表現クラスのどれかを保持する場合、Doc実装がこのメソッドをサポートする必要があります。保持しない場合、nullが返されます。

• char[]
• java.lang.String
• java.io.Reader

docの印刷データ表現オブジェクトを使用して、印刷データを文字のストリームとして読み取るためのReaderを構築して返します。ただし、印刷データ表現オブジェクト自体がReaderの場合、印刷データ表現オブジェクトが返されるだけです。

定義:

getReaderForText、インタフェース: Doc

戻り値:

このdocから印刷データ文字を読み取るためのReader。このdocが上記の基準を満たさないためにリーダーを使用できない場合、nullが返される。

例外:

IOException - リーダーの作成時に入出力エラーが発生した場合。

getStreamForBytes

public InputStream getStreamForBytes()
                              throws IOException

このdocからバイト印刷データを抽出するための入力ストリームを取得します。DocFlavorが次の印刷データ表現クラスのどれかを保持する場合、Doc実装がこのメソッドをサポートする必要があります。そうでない場合はこのメソッドからnullが返されます。

• byte[]
• java.io.InputStream

docの印刷データ表現オブジェクトが取得されます。その後、印刷データ表現オブジェクトから印刷データをバイト・ストリームとして読み取るための入力ストリームが作成され、返されます。ただし、印刷データ表現オブジェクト自体が入力ストリームの場合は、印刷データ表現オブジェクトが返されるだけです。

定義:

getStreamForBytes、インタフェース: Doc

戻り値:

このdocから印刷データ・バイトを読み取るためのInputStream。このdocが上記の基準を満たさないために入力ストリームを使用できない場合、nullが返される。

例外:

IOException - 入力ストリームの作成中に入出力エラーが発生した場合。