Класс 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 - объект DocFlavor; attributes - набор DocAttributeSet, который может быть null
Исключения:: IllegalArgumentException - если flavor или printData является null, или набор 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
Возвращает:: InputStream для чтения байтов данных печати из этого документа. Если входной поток не может быть предоставлен, потому что этот документ не соответствует вышеуказанным критериям, возвращается null.
Исключения:: IOException - если при создании входного потока произошла ошибка ввода-вывода

© 1993, 2021, 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/17/docs/api/java.desktop/javax/print/SimpleDoc.html