Интерфейс PrintService

String getName()

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

DocPrintJob createPrintJob()

Создаёт и возвращает PrintJob, способный обрабатывать данные из любого из поддерживаемых форматов документов.

void addPrintServiceAttributeListener(PrintServiceAttributeListener listener)

Регистрирует слушателя событий для этой PrintService.

void removePrintServiceAttributeListener(PrintServiceAttributeListener listener)

Удаляет слушателя службы печати из этой службы печати. Это означает, что слушатель больше не заинтересован в событиях PrintService.

PrintServiceAttributeSet getAttributes()

Получает набор атрибутов описания принтера для этой службы печати, предоставляющий её состояние. Возвращаемый объект набора атрибутов неизменяем. Возвращаемый объект набора атрибутов представляет собой «моментальный снимок» набора атрибутов этой службы печати на момент вызова метода getAttributes(): то есть содержимое возвращаемого набора атрибутов не будет обновляться, если содержимое набора атрибутов этой службы печати изменится в будущем. Чтобы обнаружить изменения в значениях атрибутов, вызовите getAttributes() ещё раз и сравните новый набор атрибутов со старым; альтернативно, зарегистрируйте слушателя событий службы печати.

<T extends PrintServiceAttribute> T getAttribute(Class<T> category)

Получает значение указанного атрибута службы. Это может быть полезно для клиентов, которым нужно только значение одного атрибута и которые хотят свести к минимуму накладные расходы.

DocFlavor[] getSupportedDocFlavors()

Определяет форматы данных печати, которые клиент может указать при настройке задания для этой PrintService. Формат данных печати обозначается «форматом документа» (класс DocFlavor), состоящим из типа MIME и класса представления данных печати.

Обратите внимание, что некоторые форматы документов могут не поддерживаться в сочетании со всеми атрибутами. Используйте getUnsupportedAttributes(..) для проверки определённых комбинаций.

boolean isDocFlavorSupported(DocFlavor flavor)

Определяет, поддерживает ли эта служба печати определённый DocFlavor. Это удобный метод для определения, будет ли DocFlavor членом результата getSupportedDocFlavors().

Обратите внимание, что некоторые форматы документов могут не поддерживаться в сочетании со всеми атрибутами. Используйте getUnsupportedAttributes(..) для проверки определённых комбинаций.

Class<?>[] getSupportedAttributeCategories()

Определяет категории атрибутов печати, которые клиент может указать при настройке задания для этой службы печати. Категория атрибута печати обозначается Class, реализующим интерфейс Attribute. Этот метод возвращает только поддерживаемые категории атрибутов; он не возвращает конкретные поддерживаемые значения атрибутов.

Этот метод возвращает все поддерживаемые категории атрибутов печати этой службы печати для любого возможного задания. Некоторые категории могут не поддерживаться в конкретном контексте (например, для конкретного DocFlavor). Используйте один из методов, включающих DocFlavor, для проверки запроса перед его отправкой, например getSupportedAttributeValues(..).

boolean isAttributeCategorySupported(Class<? extends Attribute> category)

Определяет, может ли клиент указать заданную категорию атрибута печати при настройке задания для этой службы печати. Категория атрибута печати обозначается Class, реализующим интерфейс Attribute. Этот метод показывает, поддерживается ли категория атрибута; он не показывает, поддерживается ли конкретное значение атрибута.

Некоторые категории могут не поддерживаться в конкретном контексте (например, для конкретного DocFlavor). Используйте один из методов, включающих DocFlavor, для проверки запроса перед его отправкой, например getSupportedAttributeValues(..).

Это удобный метод для определения, будет ли категория членом результата getSupportedAttributeCategories().

Object getDefaultAttributeValue(Class<? extends Attribute> category)

Определяет значение по умолчанию атрибута печати этой службы печати в данной категории. Значение атрибута печати является экземпляром класса, реализующего интерфейс Attribute. Если клиент настраивает задание печати и не указывает значение атрибута в данной категории, эта служба печати будет использовать значение атрибута по умолчанию вместо этого.

Некоторые атрибуты могут не поддерживаться в определённом контексте (например, для определённого DocFlavor). Используйте один из методов, включающих DocFlavor, для проверки запроса перед его отправкой, например getSupportedAttributeValues(..).

Не все атрибуты имеют значение по умолчанию. Например, у службы не будет значения по умолчанию для RequestingUser, т. е. null для поддерживаемой категории означает, что для этой категории нет значения по умолчанию службы. Используйте метод isAttributeCategorySupported(Class) для различения этих случаев.

Object getSupportedAttributeValues(Class<? extends Attribute> category, DocFlavor flavor, AttributeSet attributes)

Определяет значения атрибутов печати, которые клиент может указать в заданной категории при настройке задания для этой службы печати. Значение атрибута печати — это экземпляр класса, реализующего интерфейс Attribute.

Если flavor равно null и attributes равно null или является пустым множеством, этот метод возвращает все значения атрибутов печати, которые поддерживает эта служба печати для любого возможного задания. Если flavor не равно null или attributes не является пустым множеством, этот метод возвращает только те значения атрибутов печати, которые совместимы с заданным типом документа и/или набором атрибутов. То есть, возвращаемое значение null может указывать на то, что указание этого атрибута несовместимо с указанным DocFlavor. Также, если DocFlavor не равно null, оно должно быть типом, поддерживаемым этой PrintService, в противном случае будет брошено исключение IllegalArgumentException.

Если параметр attributes содержит атрибут Attribute, категория которого совпадает с параметром category, служба должна проигнорировать этот атрибут в AttributeSet.

Атрибуты DocAttribute, которые должны быть указаны в Doc, должны быть включены в этот набор для точного представления контекста.

Этот метод возвращает Object, потому что разные категории атрибутов печати по-разному указывают поддерживаемые значения атрибутов. Документация по каждому атрибуту печати в пакете javax.print.attribute.standard описывает, как каждый атрибут указывает свои поддерживаемые значения. Возможные способы указания поддержки включают:

• Возврат единственного экземпляра категории атрибута, чтобы указать, что любое значение допустимо — используется, например, атрибутом, значение которого является произвольной строкой текста. (Значение возвращаемого объекта атрибута не имеет значения.)
• Возврат массива одного или нескольких экземпляров категории атрибута, содержащего допустимые значения — используется, например, атрибутом со списком перечислений. Тип массива — массив указанного типа категории атрибута, как возвращается его getCategory(Class).
• Возврат одного объекта (отличного от категории атрибута), который указывает границы допустимых значений — используется, например, целым атрибутом, который должен находиться в определённом диапазоне.

boolean isAttributeValueSupported(Attribute attrval, DocFlavor flavor, AttributeSet attributes)

Определяет, может ли клиент указать данное значение атрибута печати при настройке задания для этой службы печати. Значение атрибута печати — это экземпляр класса, реализующего интерфейс Attribute.

Если flavor равно null и attributes равно null или является пустым множеством, этот метод сообщает, поддерживает ли эта служба печати данное значение атрибута печати для некоторой возможной комбинации типа документа и набора атрибутов. Если flavor не равно null или attributes не является пустым множеством, этот метод сообщает, поддерживает ли эта служба печати данное значение атрибута печати в сочетании с заданным типом документа и/или набором атрибутов.

Также, если DocFlavor не равно null, оно должно быть типом, поддерживаемым этой PrintService, в противном случае будет брошено исключение IllegalArgumentException.

Атрибуты DocAttribute, которые должны быть указаны в Doc, должны быть включены в этот набор для точного представления контекста.

Это вспомогательный метод для определения, будет ли значение членом результата getSupportedAttributeValues(...).

AttributeSet getUnsupportedAttributes(DocFlavor flavor, AttributeSet attributes)

Идентифицирует атрибуты, которые не поддерживаются для запроса печати в контексте конкретного DocFlavor. Этот метод полезен для проверки потенциального задания печати и выявления конкретных атрибутов, которые не могут быть поддержаны. Важно предоставить только поддерживаемый DocFlavor или будет брошено исключение IllegalArgumentException. Если возвращаемое значение от этого метода является null, все атрибуты поддерживаются.

Атрибуты DocAttribute, которые должны быть указаны в Doc, должны быть включены в этот набор для точного представления контекста.

Если возвращаемое значение является non-null, все атрибуты в возвращаемом наборе не поддерживаются с этим DocFlavor. Возвращаемый набор не различает категории атрибутов, которые не поддерживаются, от неподдерживаемых значений атрибутов.

Поддерживаемый запрос печати может быть создан путем удаления всех неподдерживаемых атрибутов из исходного набора атрибутов, за исключением случая, когда DocFlavor не поддерживается.

Если какие-либо атрибуты не поддерживаются только потому, что они конфликтуют с другими атрибутами, то по усмотрению службы выбирается атрибут(ы), который(е) будет(и) определён(ы) как причина конфликта.

Используйте isDocFlavorSupported() для проверки того, что DocFlavor поддерживается перед вызовом этого метода.

ServiceUIFactory getServiceUIFactory()

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

boolean equals(Object obj)

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

Клиенты должны вызывать этот метод, чтобы определить, ссылаются ли две службы на один и тот же базовый сервис.

Службы должны реализовать этот метод и вернуть true только в том случае, если объекты служб, которые сравниваются, могут быть взаимозаменяемы клиентом. Службы могут свободно возвращать один и тот же объект ссылки на базовый сервис, если это так, но клиенты не должны полагаться на равенство ссылок.

int hashCode()

Этот метод должен быть реализован согласованно с equals(Object).