Класс AbstractWriter

java.lang.Object

javax.swing.text.AbstractWriter

Прямые известные подклассы:: HTMLWriter, MinimalHTMLWriter

public abstract class AbstractWriter extends Object

AbstractWriter — это абстрактный класс, который выполняет фактическую запись дерева элементов, включая атрибуты. По умолчанию writer записывает не более 100 символов в строке. Это значение можно изменить в подклассах.

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

Модификатор и тип	Поле	Описание
`protected static final char`	`NEWLINE`	Как текстовый пакет моделирует символы новой строки.

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

AbstractWriter(Writer w,
 Document doc)

AbstractWriter(Writer w,
 Document doc,
 int pos,
 int len)

AbstractWriter(Writer w,
 Element root)

AbstractWriter(Writer w,
 Element root,
 int pos,
 int len)

Модификатор	Конструктор	Описание
`protected`	Создает новый AbstractWriter.
`protected`	Создает новый AbstractWriter.
`protected`	Создает новый AbstractWriter.
`protected`	Создает новый AbstractWriter.

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

Модификатор и тип	Метод	Описание
`protected void`	`decrIndent()`	Уменьшает уровень отступа.
`protected boolean`	`getCanWrapLines()`	Возвращает, можно ли переносить строки.
`protected int`	`getCurrentLineLength()`	Возвращает текущую длину строки.
`protected Document`	`getDocument()`	Возвращает документ.
`protected ElementIterator`	`getElementIterator()`	Возвращает ElementIterator.
`int`	`getEndOffset()`	Возвращает последнее смещение, которое будет выведено.
`protected int`	`getIndentLevel()`	Возвращает текущий уровень отступа.
`protected int`	`getIndentSpace()`	Возвращает ширину отступа в пробелах.
`protected int`	`getLineLength()`	Возвращает максимальную длину строки.
`String`	`getLineSeparator()`	Возвращает строку, используемую для представления символов новой строки.
`int`	`getStartOffset()`	Возвращает первое смещение, которое будет выведено.
`protected String`	`getText(Element elem)`	Возвращает текст, связанный с элементом.
`protected Writer`	`getWriter()`	Возвращает Writer, используемый для вывода содержимого.
`protected void`	`incrIndent()`	Увеличивает уровень отступа.
`protected void`	`indent()`	Выполняет отступ.
`protected boolean`	`inRange(Element next)`	Этот метод определяет, входит ли текущий элемент в указанный диапазон.
`protected boolean`	`isLineEmpty()`	Возвращает true, если текущую строку следует считать пустой.
`protected void`	`output(char[] content, int start, int length)`	Последний этап записи содержимого.
`protected void`	`setCanWrapLines(boolean newValue)`	Задает, можно ли переносить строки.
`protected void`	`setCurrentLineLength(int length)`	Задает текущую длину строки.
`protected void`	`setIndentSpace(int space)`	Позволяет подклассам указывать, скольким пробелам соответствует один уровень отступа.
`protected void`	`setLineLength(int l)`	Позволяет подклассам задавать количество символов для вывода в каждой строке.
`void`	`setLineSeparator(String value)`	Задает строку, используемую для представления символов новой строки.
`protected void`	`text(Element elem)`	Записывает текст.
`protected abstract void`	`write()`	Этот абстрактный метод должен быть реализован в подклассах.
`protected void`	`write(char ch)`	Записывает символ.
`protected void`	`write(char[] chars, int startIndex, int length)`	Все методы записи вызывают этот метод.
`protected void`	`write(String content)`	Записывает строку.
`protected void`	`writeAttributes(AttributeSet attr)`	Записывает набор атрибутов в виде пар « <name>=<value>».
`protected void`	`writeLineSeparator()`	Записывает разделитель строк.

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

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли этот объект другому объекту.
`protected void`	`finalize()`	Устарел и подлежит удалению: этот элемент API может быть удален в будущей версии. Финализация объявлена устаревшей и подлежит удалению в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо истечения заданного времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо истечения заданного времени.

Подробное описание полей

NEWLINE

protected static final char NEWLINE

Как текстовый пакет моделирует символы новой строки.

См. также:

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

AbstractWriter

protected AbstractWriter(Writer w, Document doc)

Создает новый AbstractWriter. Инициализирует ElementIterator корневым элементом документа по умолчанию.

Параметры:: w — Writer.; doc — Document

AbstractWriter

protected AbstractWriter(Writer w, Document doc, int pos, int len)

Создает новый AbstractWriter. Инициализирует ElementIterator переданным элементом.

Параметры:: w — Writer; doc — Element; pos — позиция в документе, откуда нужно получить содержимое.; len — объем записываемых данных.

AbstractWriter

protected AbstractWriter(Writer w, Element root)

Создает новый AbstractWriter. Инициализирует ElementIterator переданным элементом.

Параметры:: w — Writer; root — Element

AbstractWriter

protected AbstractWriter(Writer w, Element root, int pos, int len)

Создает новый AbstractWriter. Инициализирует ElementIterator переданным элементом.

Параметры:: w — Writer; root — Element; pos — позиция в документе, откуда нужно получить содержимое.; len — объем записываемых данных.

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

getStartOffset

public int getStartOffset()

Возвращает первое смещение, которое будет выведено.

Возвращает:: первое смещение, которое будет выведено
С версии:: 1.3

getEndOffset

public int getEndOffset()

Возвращает последнее смещение, которое будет выведено.

Возвращает:: последнее смещение, которое будет выведено
С версии:: 1.3

getElementIterator

protected ElementIterator getElementIterator()

Возвращает ElementIterator.

Возвращает:: ElementIterator.

getWriter

protected Writer getWriter()

Возвращает Writer, используемый для вывода содержимого.

Возвращает:: Writer, используемый для вывода содержимого
С версии:: 1.3

getDocument

protected Document getDocument()

Возвращает документ.

Возвращает:: Document.

inRange

protected boolean inRange(Element next)

Этот метод определяет, входит ли текущий элемент в указанный диапазон. Если диапазон не задан, он охватывает весь документ. Метод inRange() возвращает true, если заданный диапазон пересекается с диапазоном элемента.

Параметры:: next — Element.
Возвращает:: значение boolean, указывающее, входит ли элемент в диапазон.

write

protected abstract void write() throws IOException, BadLocationException

Этот абстрактный метод должен быть реализован в подклассах. Он отвечает за обход элементов и использование методов write() для формирования выходных данных в требуемом формате.

Исключения:: IOException — если произошла ошибка ввода-вывода; BadLocationException — если указано недопустимое расположение в документе

getText

protected String getText(Element elem) throws BadLocationException

Возвращает текст, связанный с элементом. Предполагается, что элемент является конечным. При возникновении BadLocationException выбрасывается исключение.

Параметры:: elem — Element
Возвращает:: текст в виде String
Исключения:: BadLocationException — если pos представляет недопустимое расположение в документе

text

protected void text(Element elem) throws BadLocationException, IOException

Записывает текст. Если при вызове конструктора был указан диапазон, записывается только соответствующая часть текста.

Параметры:: elem — Element.
Исключения:: IOException — при любой ошибке ввода-вывода; BadLocationException — если pos представляет недопустимое расположение в документе.

setLineLength

protected void setLineLength(int l)

Позволяет подклассам задавать количество символов для вывода в каждой строке. Значение по умолчанию — 100.

Параметры:: l — максимальная длина строки.

getLineLength

protected int getLineLength()

Возвращает максимальную длину строки.

Возвращает:: максимальная длина строки
С версии:: 1.3

setCurrentLineLength

protected void setCurrentLineLength(int length)

Задает текущую длину строки.

Параметры:: length — новая длина строки
С версии:: 1.3

getCurrentLineLength

protected int getCurrentLineLength()

Возвращает текущую длину строки.

Возвращает:: текущая длина строки
С версии:: 1.3

isLineEmpty

protected boolean isLineEmpty()

Возвращает true, если текущую строку следует считать пустой. Это верно, когда getCurrentLineLength == 0 или для пустой строки был вызван indent.

Возвращает:: true, если текущую строку следует считать пустой
С версии:: 1.3

setCanWrapLines

protected void setCanWrapLines(boolean newValue)

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

Параметры:: newValue — новое значение для переноса строк
С версии:: 1.3

getCanWrapLines

protected boolean getCanWrapLines()

Возвращает, можно ли переносить строки. Если значение равно false, разделители строк не выводятся.

Возвращает:: можно ли переносить строки
С версии:: 1.3

setIndentSpace

protected void setIndentSpace(int space)

Позволяет подклассам указывать, скольким пробелам соответствует один уровень отступа. При отступе уровень отступа умножается на это значение. Значение по умолчанию — 2.

Параметры:: space — значение int, задающее соответствие уровня отступа количеству пробелов.

getIndentSpace

protected int getIndentSpace()

Возвращает ширину отступа в пробелах.

Возвращает:: ширина отступа в пробелах
С версии:: 1.3

setLineSeparator

public void setLineSeparator(String value)

Задает строку, используемую для представления символов новой строки. При создании она инициализируется значением из Document или системного свойства line.separator.

Параметры:: value — новый разделитель строк
С версии:: 1.3

getLineSeparator

public String getLineSeparator()

Возвращает строку, используемую для представления символов новой строки.

Возвращает:: строка, используемая для представления символов новой строки
С версии:: 1.3

incrIndent

protected void incrIndent()

Увеличивает уровень отступа. Если отступ привел бы к тому, что getIndentSpace() *getIndentLevel() стало бы больше getLineLength(), отступ не будет добавлен.

decrIndent

protected void decrIndent()

Уменьшает уровень отступа.

getIndentLevel

protected int getIndentLevel()

Возвращает текущий уровень отступа, то есть количество вызовов incrIndent за вычетом количества вызовов decrIndent.

Возвращает:: текущий уровень отступа
С версии:: 1.3

indent

protected void indent() throws IOException

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

Исключения:: IOException — при любой ошибке ввода-вывода

write

protected void write(char ch) throws IOException

Записывает символ. Реализация вызывает метод write, принимающий char[].

Параметры:: ch — char.
Исключения:: IOException — при любой ошибке ввода-вывода

write

protected void write(String content) throws IOException

Записывает строку. Реализация вызывает метод write, принимающий char[].

Параметры:: content — String.
Исключения:: IOException — при любой ошибке ввода-вывода

writeLineSeparator

protected void writeLineSeparator() throws IOException

Записывает разделитель строк. Метод напрямую вызывает output и устанавливает lineLength в 0.

Исключения:: IOException — при любой ошибке ввода-вывода
С версии:: 1.3

write

protected void write(char[] chars, int startIndex, int length) throws IOException

Все методы записи вызывают этот метод. Если getCanWrapLines() возвращает false, метод вызывает output для каждой последовательности chars, не содержащей NEWLINE, а затем вызывает writeLineSeparator. Если же getCanWrapLines() возвращает true, строка при необходимости разбивается, чтобы соблюдалось getLineLength. Единственное исключение возникает, если текущая строка не содержит пробельных символов и не помещается: в этом случае длина строки превысит getLineLength.

Параметры:: chars — символы для вывода; startIndex — начальный индекс; length — длина вывода
Исключения:: IOException — при любой ошибке ввода-вывода
С версии:: 1.3

writeAttributes

protected void writeAttributes(AttributeSet attr) throws IOException

Записывает набор атрибутов в виде пар « <name>=<value>». При возникновении ошибки выбрасывается IOException.

Параметры:: attr — AttributeSet.
Исключения:: IOException — при любой ошибке ввода-вывода

output

protected void output(char[] content, int start, int length) throws IOException

Последний этап записи содержимого. В конечном счете все методы записи вызывают этот метод, который вызывает write для Writer.

Этот метод также обновляет длину строки на основе length. Если метод вызывается для вывода символа новой строки, текущую длину строки необходимо сбросить, поскольку прежнее значение станет недействительным. Это должен сделать вызывающий код. Для записи символа новой строки используйте writeLineSeparator: он корректно обновляет текущую длину строки.

Параметры:: content — символы для вывода; start — начальный индекс; length — длина вывода
Исключения:: IOException — при любой ошибке ввода-вывода
С версии:: 1.3

© 1993, 2025, 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.