Класс SimpleDoc

java.lang.Object

javax.print.SimpleDoc

Все реализованные интерфейсы:: Doc

public final class SimpleDoc extends Object implements Doc

Этот класс является реализацией интерфейса Doc, который может использоваться во многих стандартных запросах на печать. Он может обрабатывать все определённые в настоящее время «предварительно определённые» форматы документов, заданные как статические переменные в классе DocFlavor.

В частности, этот класс реализует некоторые необходимые семантики спецификации Doc следующим образом:

создаёт поток для сервиса, если это запрошено и уместно.
гарантирует, что каждый вызов метода возвращает тот же объект.
гарантирует, что к Doc могут получить доступ несколько потоков.
выполняет проверку соответствия данных формату документа.

Клиенты, которые хотят повторно использовать объект документа в других заданиях или нуждаются в MultiDoc не должны использовать этот класс.

Если данные для печати являются потоком, или задание печати запрашивает данные в виде потока, тогда SimpleDoc не отслеживает, закрывает ли служба поток должным образом после завершения передачи данных или завершения задания. Клиенты могут предпочесть использовать свою собственную реализацию документа, которая добавляет слушатель для отслеживания завершения задания и проверки того, что ресурсы, такие как потоки, освобождены (т.е. закрыты).

Краткое описание конструкторов

Конструктор	Описание
`SimpleDoc(Object printData, DocFlavor flavor, DocAttributeSet attributes)`	Создаёт `SimpleDoc` с указанными данными для печати, форматом документа и набором атрибутов документа.

Краткое описание методов

Модификатор и тип	Метод	Описание
`DocAttributeSet`	`getAttributes()`	Получает набор атрибутов печати для данного объекта документа.
`DocFlavor`	`getDocFlavor()`	Определяет формат документа, в котором этот объект документа предоставит свои данные для печати.
`Object`	`getPrintData()`	Получает объект представления данных для печати, который содержит часть данных для печати этого объекта документа в формате, соответствующем поддерживаемому формату документа.
`Reader`	`getReaderForText()`	Получает ридер для извлечения данных печати символов из этого документа.
`InputStream`	`getStreamForBytes()`	Получает поток ввода для извлечения данных печати байтов из этого документа.

Методы, объявленные в классе java.lang.Object

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

Подробное описание конструкторов

SimpleDoc

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

Создаёт SimpleDoc с указанными данными для печати, форматом документа и набором атрибутов документа.

Параметры:: printData - объект данных для печати; flavor - объект формата документа; attributes - набор атрибутов документа, которые могут быть null
Исключения:: IllegalArgumentException - если flavor или printData некорректны, или набор атрибутов не соответствует указанному формату документа — например, данные не соответствуют типу, указанному в представлении DocFlavor

Подробное описание методов

getDocFlavor

public DocFlavor getDocFlavor()

Определяет формат документа, в котором этот объект документа предоставит свои данные для печати.

Определено в:: getDocFlavor в интерфейсе Doc
Возвращает:: формат документа

getAttributes

public DocAttributeSet getAttributes()

Получает набор атрибутов печати для данного объекта документа. Если возвращаемый набор атрибутов включает экземпляр конкретного атрибута X, принтер должен использовать значение этого атрибута для данного документа, переопределяя любое значение атрибута X в наборе атрибутов задания. Если возвращаемый набор атрибутов не включает экземпляр конкретного атрибута X или если null возвращается, принтер должен обратиться к набору атрибутов задания для получения значения атрибута X, а если не найдено там, принтер должен использовать значение по умолчанию, зависящее от реализации. Возвращаемый набор атрибутов неизменяемый.

Определено в:: getAttributes в интерфейсе Doc
Возвращает:: неизменяемый набор атрибутов печати для данного документа или null для получения всех значений атрибутов из набора атрибутов задания

getPrintData

public Object getPrintData() throws IOException

Получает объект представления данных для печати, который содержит часть данных для печати этого объекта документа в формате, соответствующем поддерживаемому формату документа. Метод getPrintData() возвращает экземпляр класса представления, имя которого задано в getDocFlavor().getRepresentationClassName(), и возвращаемое значение может быть приведено к классу Object к этому классу представления.

Определено в:: getPrintData в интерфейсе Doc
Возвращает:: объект представления данных для печати
Исключения:: IOException - если класс представления является потоком и произошла ошибка ввода-вывода при создании потока

getReaderForText

public Reader getReaderForText() throws IOException

Получает ридер для извлечения данных печати символов из этого документа. Реализация Doc должна поддерживать этот метод, если у DocFlavor есть один из следующих классов представления данных для печати, и возвращать null в противном случае:

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

Объект представления данных для печати документа используется для построения и возврата Reader для чтения данных печати в виде потока символов из объекта представления данных для печати. Однако, если сам объект представления данных для печати является Reader то объект представления данных для печати просто возвращается.

Определено в:: getReaderForText в интерфейсе Doc
Возвращает:: Reader для чтения символов данных печати из этого документа. Если ридер предоставить невозможно, потому что этот документ не соответствует вышеуказанным критериям, возвращается null.
Исключения:: IOException - если произошла ошибка ввода-вывода при создании ридера

getStreamForBytes

public InputStream getStreamForBytes() throws IOException

Получает поток ввода для извлечения данных печати байтов из этого документа. Реализация Doc должна поддерживать этот метод, если у DocFlavor есть один из следующих классов представления данных для печати; в противном случае этот метод возвращает null:

byte[]
java.io.InputStream

Получается объект представления данных для печати документа. Затем создаётся и возвращается поток ввода для чтения данных печати из объекта представления данных для печати в виде потока байтов. Однако, если сам объект представления данных для печати является потоком ввода, то объект представления данных для печати просто возвращается.

Определено в:: getStreamForBytes в интерфейсе Doc
Возвращает:: поток ввода для чтения байтов данных печати из этого документа. Если поток ввода предоставить невозможно, потому что этот документ не соответствует вышеуказанным критериям, возвращается null.
Исключения:: IOException - если произошла ошибка ввода-вывода при создании потока ввода

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/print/SimpleDoc.html