javax.print

Класс DocFlavor

java.lang. Объект

javax.print. DocFlavor

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

Сериализуемый, Cloneable

Прямые Известные Подклассы:

DocFlavor. BYTE_ARRAY, DocFlavor. CHAR_ARRAY, DocFlavor. INPUT_STREAM, DocFlavor. ЧИТАТЕЛЬ, Докфлэвор. SERVICE_FORMATTED, DocFlavor. СТРОКА, DocFlavor. URL

public class DocFlavor
extends Object
implements Serializable, Cloneable

Класс DocFlavor инкапсулирует объект, который определяет формат, в котором данными печати снабжают к a DocPrintJob. "Документ" является коротким, термин, "легкий объявить, что" это означает "часть данных печати." Формат данных печати, или "разновидность документа", состоит из двух вещей:

• Тип MIME. Это - Многоцелевое расширение возможностей почты в сети Интернет (MIME) тип носителя (как определено в RFC 2045 и RFC 2046), который определяет, как данные печати должны быть интерпретированы. Набор символов текстовых данных должен быть IANA предпочтенное MIME имя, или его каноническое имя, если никакое привилегированное имя не определяется. Дополнительно несколько исторических имен, поддерживаемых более ранними версиями платформы Java, могут быть распознаны. См. кодировки символов для получения дополнительной информации о кодировках символов, поддерживаемых на платформе Java.

• Имя класса представления. Это определяет полностью определенное имя класса объекта, из которого фактические данные печати прибывают, как возвращено Class.getName() метод. (Таким образом имя класса для byte[] "[B", для char[] это "[C".)

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

Клиент Отформатированные Данные Печати

Есть две широких категории данных печати, клиент отформатированные данные печати и служба отформатированные данные печати.

Для клиента отформатированные данные печати клиент определяет или знает формат данных печати. Например клиент может иметь JPEG закодированное изображение, URL для кода HTML, или дисковый файл, содержащий простой текст в некотором кодировании, возможно полученном из внешнего источника, и требует способа описать формат данных к службе печати.

Класс представления разновидности документа является кабелепроводом для JPS DocPrintJob получить последовательность символов или байтов от клиента. Тип MIME разновидности документа является одним из стандартных типов носителя, говорящих, как интерпретировать последовательность символов или байтов. Для списка стандартных типов носителя см. Каталог Типов носителя (IANA) Комитета по цифровым адресам в интернете. Интерфейс Doc обеспечивает две служебных операции, getReaderForText и getStreamForBytes(), помочь a Doc клиент объекта извлекает клиент отформатированные данные печати.

Для клиента отформатированные данные печати класс представления данных печати обычно является одним из следующих (хотя другие классы представления разрешаются):

• Символьный массив (char[]) - Данные печати состоят из символов Unicde в массиве.

• String - Данные печати состоят из символов Unicode в строке.

• Символьный поток (java.io.Reader) - Данные печати состоят из символов Unicode, считанных из потока до конца потока.

• Байтовый массив (byte[]) - Данные печати состоят из байтов в массиве. Байты кодируются в наборе символов, определенном типом MIME разновидности документа. Если тип MIME не определяет набор символов, набором символов по умолчанию является US-ASCII.

• Поток байтов (java.io.InputStream) - Данные печати состоят из байтов, считанных из потока до конца потока. Байты кодируются в наборе символов, определенном типом MIME разновидности документа. Если тип MIME не определяет набор символов, набором символов по умолчанию является US-ASCII.
• Универсальный Локатор Ресурса (URL) - Данные печати состоят из байтов, считанных из расположения URL. Байты кодируются в наборе символов, определенном типом MIME разновидности документа. Если тип MIME не определяет набор символов, набором символов по умолчанию является US-ASCII.

  Когда класс представления является URL, служба печати непосредственно доступы и загружает документ непосредственно с его адреса URL, не включая клиент. Служба может быть некоторой формой сетевой службы печати, которая выполняется в различной среде. Это означает, что недопустимо использовать разновидность данных печати URL, чтобы напечатать документ в ограниченном URL, который может видеть клиент, но принтер не может видеть. Это также означает, что недопустимо использовать разновидность данных печати URL, чтобы напечатать документ, хранивший в локальном файле, который не доступен в URL, доступном независимо от клиента. Например, файл, который не подается сервером HTTP или сервером FTP. Чтобы напечатать такие документы, позвольте клиенту открывать входной поток на URL или файле и использовать входную потоковую разновидность данных.

Значение по умолчанию и Кодировки Платформы

Поскольку байт печатает данные, где тип MIME разновидности документа не включает a charset параметр, экземпляр Службы печати Java принимает набор символов US-ASCII по умолчанию. Это в соответствии с RFC 2046, который говорит, что набором символов по умолчанию является US-ASCII. Отметьте, что US-ASCII является подмножеством UTF-8, таким образом, в будущем это может быть расширено, если будущий RFC подтверждает UTF-8 как значение по умолчанию совместимым способом.

Также отметьте, что это отличается чем поведение Среды выполнения Java, интерпретируя поток байтов как текстовые данные. Это принимает кодировку по умолчанию для локали пользователя. Таким образом записывая в буферный файл файл в локальном кодировании к Службе печати Java важно правильно определить кодирование. Разработчики, работающие в английских локалях, должны особенно ощущать это, поскольку их кодирование платформы соответствует набору символов пантомимы по умолчанию. По этому совпадению, что особый случай может работать, не определяя кодирование данных платформы.

Каждому экземпляру виртуальной машины Java определили кодировку символов по умолчанию во время запуска виртуальной машины и обычно зависит от локали и набора символов, используемого базовой операционной системой. В распределенной среде нет никакого gurantee что доля двух VM та же самая кодировка по умолчанию. Таким образом клиенты, которые хотят передать платформу потоком закодированные текстовые данные от платформы узла до экземпляра Службы печати Java, должны явно объявить набор символов и не положиться на значения по умолчанию.

Привилегированная форма является официальным IANA основное имя для кодирования. Приложения, какие потоковые текстовые данные должны всегда определять набор символов в типе пантомимы, который требует получать кодирование платформы узла для данных (eg файлы) сохраненный в кодировании той платформы. CharSet, который соответствует этому и является подходящим для использования в типе пантомимы для DocFlavor, может быть получен из DocFlavor.hostEncoding Это, возможно, всегда не основное имя IANA, но, как гарантируют, будет понято под этим VM. Для общих разновидностей может использоваться предопределенный *HOST DocFlavors.

См. кодировки символов для получения дополнительной информации о кодировках символов, поддерживаемых на платформе Java.

Рекомендуемый DocFlavors

API Службы печати Java не определяет в обязательном порядке поддерживаемого DocFlavors. Однако, вот некоторые примеры типов MIME, что экземпляр Службы печати Java мог бы поддерживать для клиента отформатированные данные печати. Вложенные классы в классе DocFlavor объявляют предопределенные статические постоянные объекты DocFlavor для этих разновидностей документа в качестве примера; конструктор DocFlavor класса может использоваться, чтобы создать произвольную разновидность документа.

• Предварительно отформатированный текст

  Тип MIME	Описание
  "text/plain"	Простой текст в наборе символов по умолчанию (US-ASCII)
  "text/plain; charset=xxx"	Простой текст в наборе символов xxx
  "text/html"	Язык разметки гипертекста в наборе символов по умолчанию (US-ASCII)
  "text/html; charset=xxx"	Язык разметки гипертекста в наборе символов xxx

  Вообще, предварительно отформатированным текстовым данным печати предоставляют любому в символьно-ориентированном классе представления (символьный массив, Строка, Читатель) или в байте ориентированный класс представления (байтовый массив, InputStream, URL).

• Предварительно отформатированный язык описания страниц (PDL) документы

  Тип MIME	Описание
  "application/pdf"	Документ Формата Переносимого документа
  "application/postscript"	Документ PostScript
  "application/vnd.hp-PCL"	Документ Языка управления принтера

  Вообще, предварительно отформатированные данные печати PDL обеспечиваются в байте ориентированный класс представления (байтовый массив, InputStream, URL).

• Предварительно отформатированные изображения

  Тип MIME	Описание
  "image/gif"	Изображение Формата обмена графическими данными
  "image/jpeg"	Изображение Совместной экспертной группы по фотографии
  "image/png"	Изображение Переносимой сетевой графики

  Вообще, предварительно отформатированные данные печати изображения обеспечиваются в байте ориентированный класс представления (байтовый массив, InputStream, URL).

• Предварительно отформатированный распознают данные печати автоматически

  Тип MIME	Описание
  "application/octet-stream"	Формат данных печати является неуказанным (только поток октета)

  Принтер решает, как интерпретировать данные печати; путем это "распознающее работы автоматически является зависящим от реализации. Вообще, предварительно отформатированный распознают данные печати автоматически, обеспечивается в байте ориентированный класс представления (байтовый массив, InputStream, URL).

  Служба Отформатированные Данные Печати

  Для службы отформатированные данные печати экземпляр Службы печати Java определяет формат данных печати. Класс представления разновидности документа обозначает интерфейс чьи методы DocPrintJob вызывает, чтобы определить контент, который будет напечатан - такие как интерфейс изображения renderable или Java печатаемый интерфейс. Тип MIME разновидности документа является специальным значением "application/x-java-jvm-local-objectref" указание на клиент предоставит ссылку на объект Java, который реализует интерфейс, названный как класс представления. Этот тип MIME является только заполнителем; то, что важно, является классом представления данных печати.

  Для службы отформатированные данные печати класс представления данных печати обычно является одним из следующих (хотя другие классы представления разрешаются). Вложенные классы в классе DocFlavor объявляют предопределенные статические постоянные объекты DocFlavor для этих разновидностей документа в качестве примера; конструктор DocFlavor класса может использоваться, чтобы создать произвольную разновидность документа.

  • Объект изображения Renderable - клиент предоставляет объект, который реализует интерфейс RenderableImage. Принтер вызывает методы в том интерфейсе, чтобы получить изображение, которое будет напечатано.

  • Печатаемый объект - клиент предоставляет объект, который реализует интерфейс Printable. Принтер вызывает методы в том интерфейсе, чтобы получить страницы, которые будут напечатаны, один за другим. Для каждой страницы принтер предоставляет графический контекст, и независимо от того, что клиент тянет в том графическом контексте, печатается.

  • Листаемый объект - клиент предоставляет объект, который реализует интерфейс Pageable. Принтер вызывает методы в том интерфейсе, чтобы получить страницы, которые будут напечатаны, один за другим. Для каждой страницы принтер предоставляет графический контекст, и независимо от того, что клиент тянет в том графическом контексте, печатается.

  Предопределенные Разновидности Документа

  Экземпляр Службы печати Java не обязан поддерживать следующие форматы данных печати и печатать классы представления данных. Фактически, разработчик, использующий этот класс, никогда не должен предполагать, что определенная служба печати поддерживает типы документов, соответствующие этим предопределенным разновидностям документа. Всегда запрашивайте службу печати, чтобы определить, какие разновидности документа она поддерживает. Однако, разработчики, у которых есть службы печати, которые поддерживают эти разновидности документа, поощряются обратиться к предопределенным одноэлементным экземплярам, создаваемым здесь.
  • Данные печати простого текста обеспечили через поток байтов. Определенно, следующим разновидностям документа рекомендуют поддерживаться:
    · ("text/plain", "java.io.InputStream")
    · ("text/plain; charset=us-ascii", "java.io.InputStream")
    · ("text/plain; charset=utf-8", "java.io.InputStream")

  • Renderable отображают объекты. Определенно, следующей разновидности документа рекомендуют поддерживаться:
    · ("application/x-java-jvm-local-objectref", "java.awt.image.renderable.RenderableImage")

  Экземпляру Службы печати Java позволяют поддерживать любые другие разновидности документа (или ни один) в дополнение к вышеупомянутым обязательным по выбору реализации.

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

  Кроме того каждый экземпляр Службы печати Java должен выполнить эти требования для того, чтобы обработать данные печати простого текста:

  • Символьный парный перевод строки возврата каретки (CR-LF) означает, "идут в столбец 1 следующей строки."
  • Возврат каретки (CR), который отдельно, означает символ, стоящий, "идет в столбец 1 следующей строки."
  • Перевод строки (LF), который отдельно, означает символ, стоящий, "идет в столбец 1 следующей строки."

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

  Объяснение проекта

  Класс DocFlavor в пакете javax.print.data подобен классу DataFlavor. Класс DataFlavor не используется в Службе печати Java (JPS) API по трем причинам, которые все базируются в разрешении API JPS быть совместно использованными другими API служб печати, которые, возможно, должны работать на профилях Java, которые не включают всю Платформу Java, Standard Edition.

  1. API JPS разрабатывается, чтобы использоваться в профилях Java, которые не поддерживают AWT.

  2. Реализация класса java.awt.datatransfer.DataFlavor не гарантирует, что у эквивалентных разновидностей данных будет то же самое сериализированное представление. DocFlavor делает, и может использоваться в службах, которые нуждаются в этом.

  3. Реализация класса java.awt.datatransfer.DataFlavor включает человеческое презентабельное имя как часть сериализированного представления. Это не является соответствующим как часть ограничения соответствия службы.

  Класс сериализированное представление DocFlavor использует следующую каноническую форму строки типа MIME. Таким образом две разновидности документа с типами MIME, которые не идентичны, но которые эквивалентны (у которых есть та же самая каноническая форма) можно считать равными.

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

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

См. Также:

Сериализированная Форма

Вложенная Сводка Класса

Вложенные Классы

Модификатор и Тип	Класс и Описание
static class	DocFlavor. BYTE_ARRAY Класс DocFlavor. BYTE_ARRAY обеспечивает предопределенные статические постоянные объекты DocFlavor например разновидности документа, используя байтовый массив (byte[]) как класс представления данных печати.
static class	DocFlavor. CHAR_ARRAY Класс DocFlavor. CHAR_ARRAY обеспечивает предопределенные статические постоянные объекты DocFlavor например разновидности документа, используя символьный массив (char[]) как класс представления данных печати.
static class	DocFlavor. INPUT_STREAM Класс DocFlavor. INPUT_STREAM обеспечивает предопределенные статические постоянные объекты DocFlavor например разновидности документа, используя поток байтов (java.io.InputStream) как класс представления данных печати.
static class	DocFlavor. ЧИТАТЕЛЬ Класс DocFlavor. ЧИТАТЕЛЬ обеспечивает предопределенные статические постоянные объекты DocFlavor например разновидности документа, используя символьный поток (java.io.Reader) как класс представления данных печати.
static class	DocFlavor. SERVICE_FORMATTED Класс DocFlavor. SERVICE_FORMATTED обеспечивает предопределенные статические постоянные объекты DocFlavor например разновидности документа для службы отформатированные данные печати.
static class	DocFlavor. СТРОКА Класс DocFlavor. СТРОКА обеспечивает предопределенные статические постоянные объекты DocFlavor например разновидности документа, используя строку (java.lang.String) как класс представления данных печати.
static class	DocFlavor. URL Класс DocFlavor. URL обеспечивает предопределенные статические постоянные объекты DocFlavor.

Полевая Сводка

Поля

Модификатор и Тип	Поле и Описание
static String	hostEncoding Строка, представляющая кодирование операционной системы узла.

Сводка конструктора

Конструкторы

Конструктор и Описание
DocFlavor(String mimeType, String className) Создает новый объект разновидности документа из данного типа MIME и имени класса представления.

Сводка метода

Методы

Модификатор и Тип	Метод и Описание
boolean	equals(Object obj) Определяет, равен ли этот объект разновидности документа данному объекту.
Строка	getMediaSubtype() Возвраты этот подтип носителей объекта разновидности документа (от типа MIME).
Строка	getMediaType() Возвраты этот тип носителя объекта разновидности документа (от типа MIME).
Строка	getMimeType() Возвраты эта строка типа MIME объекта разновидности документа, основанная на канонической форме.
Строка	getParameter(String paramName) Возвраты a String представление параметра MIME.
Строка	getRepresentationClassName() Возвращает имя этого класса представления объекта разновидности документа.
int	hashCode() Возвращает хэш-код для этого объекта разновидности документа.
Строка	toString() Преобразовывает это DocFlavor к строке.

Методы java.lang унаследованный от класса. Объект

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Полевая Деталь

hostEncoding

public static final String hostEncoding

Строка, представляющая кодирование операционной системы узла. Это будет следовать за соглашениями, задокументированными в RFC 2278: Регистрационные Процедуры Набора символов IANA кроме того, куда исторические имена возвращаются для совместимости с предыдущими версиями платформы Java. Значение, возвращенное из метода, допустимо только для VM, который возвращает это для использования в DocFlavor. Это - набор символов для всего "УЗЛА" предопределенный DocFlavors в выполнении VM.

Деталь конструктора

DocFlavor

public DocFlavor(String mimeType,
         String className)

Создает новый объект разновидности документа из данного типа MIME и имени класса представления. Данный тип MIME преобразовывается в каноническую форму и сохранен внутренне.

Параметры:

mimeType - Строка типа носителя MIME.

className - Полностью определенное имя класса представления.

Броски:

NullPointerException - (исключение непроверенное) Брошенный, если mimeType нуль или className нуль.

IllegalArgumentException - (исключение непроверенное) Брошенный, если mimeType не повинуется синтаксису для строки типа носителя MIME.

Деталь метода

getMimeType

public String getMimeType()

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

Возвраты:

тип пантомимы

getMediaType

public String getMediaType()

Возвраты этот тип носителя объекта разновидности документа (от типа MIME).

Возвраты:

тип носителя

getMediaSubtype

public String getMediaSubtype()

Возвраты этот подтип носителей объекта разновидности документа (от типа MIME).

Возвраты:

подтип носителей

getParameter

public String getParameter(String paramName)

Возвраты a String представление параметра MIME. Типы пантомимы могут включать параметры, которые являются обычно дополнительными. Набор символов для типов текстов является обычно полезным примером. Этот метод удобства возвратит значение указанного параметра, если Вы были определены в типе пантомимы для этой разновидности.

Параметры:

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

Возвраты:

Строка, представляющая параметр пантомимы, или нуль, если тот параметр не находится в строке типа пантомимы.

Броски:

throws - NullPointerException, если paramName является нулем.

getRepresentationClassName

public String getRepresentationClassName()

Возвращает имя этого класса представления объекта разновидности документа.

Возвраты:

имя класса представления.

toString

public String toString()

Преобразовывает это DocFlavor к строке.

Переопределения:

toString в классе Object

Возвраты:

Строка типа MIME, основанная на канонической форме. Каждое значение параметра включается в кавычки. "Класс =" параметр добавляется к строке типа MIME, чтобы указать на имя класса представления.

хэш-код

public int hashCode()

Возвращает хэш-код для этого объекта разновидности документа.

Переопределения:

hashCode в классе Object

Возвраты:

значение хэш-кода для этого объекта.

См. Также:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

равняется

public boolean equals(Object obj)

Определяет, равен ли этот объект разновидности документа данному объекту. Эти два равны, если данный объект не является нулем, экземпляр DocFlavor, имеет тип MIME, эквивалентный этому типу MIME объекта разновидности документа (то есть, у типов MIME есть тот же самый тип носителя, подтип носителей, и параметры), и имеет то же самое имя класса представления как этот объект разновидности документа. Таким образом, если два типа MIME объектов разновидности документа являются тем же самым за исключением комментариев, их считают равными. Однако, две разновидности документа возражают с типами MIME "текста/плоскости" и "текста/плоскости; charset=US-ASCII" не считаются равными, даже при том, что они представляют тот же самый тип носителя (потому что набором символов по умолчанию для простого текста является US-ASCII).

Переопределения:

equals в классе Object

Параметры:

obj - Объект протестировать.

Возвраты:

Истина, если этот объект разновидности документа равняется obj, ложь иначе.

См. Также:

Object.hashCode(), HashMap