Spec-Zone.ru › OpenJDK 21

Класс DocumentParser

java.lang.Object
javax.swing.text.html.parser.Parser
javax.swing.text.html.parser.DocumentParser
Все реализованные интерфейсы:
DTDConstants
public class DocumentParser extends Parser
Парсер HTML-документов (на самом деле, вы можете указать DTD, но вы действительно должны использовать только этот класс с html dtd в swing). Читает входной поток HTML и вызывает соответствующие методы в классе ParserCallback. Это парсер по умолчанию, используемый HTMLEditorKit для разбора HTML-ссылок.

Этот парсер будет сообщать обратной функции о всех допустимых тегах, а также о тегах, которые подразумеваются, но не указаны явно. Например, строка HTML (<p>blah) содержит только тег p. Обратная функция увидит следующие методы:

  1. handleStartTag(html, ...)
  2. handleStartTag(head, ...)
  3. handleEndTag(head)
  4. handleStartTag(body, ...)
  5. handleStartTag(p, ...)
  6. handleText(...)
  7. handleEndTag(p)
  8. handleEndTag(body)
  9. handleEndTag(html)
Элементы в курсиве подразумеваются, то есть, хотя они не были явно указаны, для правильности HTML они должны были быть присутствовать (head не является необходимым, но всё же генерируется). Для тегов, которые подразумеваются, аргумент AttributeSet будет иметь значение Boolean.TRUE для ключа HTMLEditorKit.ParserCallback.IMPLIED.

HTML.Attributes определяет безопасную по типам перечисление HTML-атрибутов. Если ключ атрибута тега определён в HTML.Attribute, HTML.Attribute будет использоваться в качестве ключа, в противном случае будет использоваться строка. Например, <p foo=bar class=neat> имеет два атрибута. foo не определён в HTML.Attribute, а class — есть, поэтому в AttributeSet будет две значения: HTML.Attribute.CLASS со строковым значением 'neat' и строковый ключ 'foo' со строковым значением 'bar'.

Аргумент position укажет начало тега, комментария или текста. Аналогично массивам, первый символ в потоке имеет позицию 0. Для тегов, которые подразумеваются, position укажет местоположение следующего встреченного тега. В первом примере подразумеваемые начальные теги body и html будут иметь ту же позицию, что и тег p, а подразумеваемые конечные теги p, html и body будут иметь одну и ту же позицию.

Так как HTML пропускает пробелы, позиция для текста будет позицией первого допустимого символа, например, в строке '\n\n\nblah' текст 'blah' будет иметь позицию 3, переводы строк пропущены.

Для атрибутов, у которых нет значения, например, в строке HTML <foo blah>, атрибут blah не имеет значения, есть два возможных значения, которые будут помещены в значение AttributeSet:

  • Если DTD не содержит определения для элемента или определение не имеет явного значения, то значение в AttributeSet будет HTML.NULL_ATTRIBUTE_VALUE.
  • Если DTD содержит явное значение, как в: <!ATTLIST OPTION selected (selected) #IMPLIED>, это значение из dtd (в данном случае выбранное) будет использовано.

После того как поток был проанализирован, обратная функция получает уведомление о наиболее вероятной строке конца строки. Строка конца строки будет одной из \n, \r или \r\n, какой из них встретился чаще всего при разборе потока.

Краткое описание полей

Поля, объявленные в классе javax.swing.text.html.parser.Parser

dtd, strict

Поля, объявленные в интерфейсе javax.swing.text.html.parser.DTDConstants

ANY, CDATA, CONREF, CURRENT, DEFAULT, EMPTY, ENDTAG, ENTITIES, ENTITY, FIXED, GENERAL, ID, IDREF, IDREFS, IMPLIED, MD, MODEL, MS, NAME, NAMES, NMTOKEN, NMTOKENS, NOTATION, NUMBER, NUMBERS, NUTOKEN, NUTOKENS, PARAMETER, PI, PUBLIC, RCDATA, REQUIRED, SDATA, STARTTAG, SYSTEM

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

Конструктор Описание
DocumentParser(DTD dtd)
Создаёт парсер документа с указанным dtd.

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

Модификатор и тип Метод Описание
protected void handleEmptyTag(TagElement tag)
Обработка пустого тега.
protected void handleEndTag(TagElement tag)
Обработка закрывающего тега.
protected void handleStartTag(TagElement tag)
Обработка открывающего тега.
protected void handleText(char[] data)
Обработка текста.
void parse(Reader in, HTMLEditorKit.ParserCallback callback, boolean ignoreCharSet)
Разбор HTML-потока с заданным DTD.

Методы, объявленные в классе javax.swing.text.html.parser.Parser

endTag, error, error, error, error, flushAttributes, getAttributes, getCurrentLine, getCurrentPos, handleComment, handleEOFInComment, handleError, handleTitle, makeTag, makeTag, markFirstTime, parse, parseDTDMarkup, parseMarkupDeclarations, startTag

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

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

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

DocumentParser

public DocumentParser(DTD dtd)
Создаёт парсер документа с указанным dtd.
Параметры:
dtd - dtd.

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

parse

public void parse(Reader in, HTMLEditorKit.ParserCallback callback, boolean ignoreCharSet) throws IOException
Разбор HTML-потока с заданным DTD.
Параметры:
in - потока для чтения источника
callback - обратная функция
ignoreCharSet - если true кодировка символов игнорируется
Исключения:
IOException - если произошла ошибка ввода/вывода

handleStartTag

protected void handleStartTag(TagElement tag)
Обработка открывающего тега.
Переопределяет:
handleStartTag в классе Parser
Параметры:
tag - обрабатываемый тег

handleEmptyTag

protected void handleEmptyTag(TagElement tag) throws ChangedCharSetException
Обработка пустого тега.
Переопределяет:
handleEmptyTag в классе Parser
Параметры:
tag - обрабатываемый тег
Исключения:
ChangedCharSetException - если кодировка символов документа изменилась

handleEndTag

protected void handleEndTag(TagElement tag)
Обработка закрывающего тега.
Переопределяет:
handleEndTag в классе Parser
Параметры:
tag - обрабатываемый тег

handleText

protected void handleText(char[] data)
Обработка текста.
Переопределяет:
handleText в классе Parser
Параметры:
data - текст раздела

© 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/swing/text/html/parser/DocumentParser.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API