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 フレーバを判別します。

定義:

インタフェース Doc 内の getDocFlavor

戻り値:

Doc フレーバ

getAttributes

public DocAttributeSet getAttributes()

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

定義:

インタフェース Doc 内の getAttributes

戻り値:

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

getPrintData

public Object getPrintData()
                    throws IOException

インタフェース Doc の記述:

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

定義:

インタフェース Doc 内の getPrintData

戻り値:

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

例外:

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

getReaderForText

public Reader getReaderForText()
                        throws IOException

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

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

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

定義:

インタフェース Doc 内の getReaderForText

戻り値:

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

例外:

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

getStreamForBytes

public InputStream getStreamForBytes()
                              throws IOException

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

• byte[]
• java.io.InputStream

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

定義:

インタフェース Doc 内の getStreamForBytes

戻り値:

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

例外:

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