Класс Segment

java.lang.Object

javax.swing.text.Segment

Все реализуемые интерфейсы:: CharSequence, Cloneable, CharacterIterator

public class Segment extends Object implements Cloneable, CharacterIterator, CharSequence

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

Segment реализует интерфейс java.text.CharacterIterator для поддержки работы с i18n-поддержкой без копирования текста в строку.

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

Модификатор и тип	Поле	Описание
`char[]`	`array`	Это массив, содержащий интересующий текст.
`int`	`count`	Это количество элементов массива, составляющих интересующий текст.
`int`	`offset`	Это смещение в массиве, с которого начинается нужный текст.

Поля, объявленные в интерфейсе java.text.CharacterIterator

DONE

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

Конструктор	Описание
`Segment()`	Создаёт новый отрезок.
`Segment(char[] array, int offset, int count)`	Создаёт новый отрезок, ссылающийся на существующий массив.

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

Модификатор и тип	Метод	Описание
`char`	`charAt(int index)`	Возвращает значение `char` по указанному индексу.
`Object`	`clone()`	Создаёт поверхностную копию.
`char`	`current()`	Получает символ в текущей позиции (как возвращается методом getIndex()).
`char`	`first()`	Устанавливает позицию на getBeginIndex() и возвращает символ в этой позиции.
`int`	`getBeginIndex()`	Возвращает начальный индекс текста.
`int`	`getEndIndex()`	Возвращает конечный индекс текста.
`int`	`getIndex()`	Возвращает текущий индекс.
`boolean`	`isPartialReturn()`	Флаг, указывающий, что частичные возвраты допустимы.
`char`	`last()`	Устанавливает позицию на getEndIndex()-1 (getEndIndex(), если текст пустой) и возвращает символ в этой позиции.
`int`	`length()`	Возвращает длину этой последовательности символов.
`char`	`next()`	Увеличивает индекс итератора на единицу и возвращает символ в новой позиции.
`char`	`previous()`	Уменьшает индекс итератора на единицу и возвращает символ в новой позиции.
`char`	`setIndex(int position)`	Устанавливает позицию на указанную позицию в тексте и возвращает этот символ.
`void`	`setPartialReturn(boolean p)`	Флаг, указывающий, что частичные возвраты допустимы.
`CharSequence`	`subSequence(int start, int end)`	Возвращает `CharSequence`, являющуюся подпоследовательностью этой последовательности.
`String`	`toString()`	Преобразует отрезок в строку.

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

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

Методы, объявленные в интерфейсе java.lang.CharSequence

chars, codePoints, isEmpty

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

array

public char[] array

Это массив, содержащий текст, который нас интересует. Этот массив никогда не должен изменяться; он доступен только для повышения эффективности.

offset

public int offset

Это смещение в массиве, с которого начинается нужный текст.

count

public int count

Это количество элементов массива, составляющих интересующий нас текст.

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

Segment

public Segment()

Создаёт новый сегмент.

Segment

public Segment(char[] array, int offset, int count)

Создаёт новый сегмент, ссылающийся на существующий массив.

Параметры:: array - массив, на который нужно сослаться; offset - смещение в массиве; count - количество символов

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

setPartialReturn

public void setPartialReturn(boolean p)

Флаг, указывающий, что частичные возвраты допустимы. Если флаг имеет значение true, реализация метода интерфейса Document.getText(position,length,Segment) должна вернуть как можно больше текста без создания копии. Значение флага по умолчанию — false, что заставит Document.getText(position,length,Segment) обеспечить такое же поведение возврата, как и всегда, что может или не может привести к созданию копии текста в зависимости от запроса.

Параметры:: p - допустимость частичных возвратов.
С тех пор как:: 1.4

isPartialReturn

public boolean isPartialReturn()

Флаг, указывающий, что частичные возвраты допустимы.

Возвращает:: допустимость частичных возвратов.
С тех пор как:: 1.4

toString

public String toString()

Преобразует сегмент в строку.

Задано в:: toString в интерфейсе CharSequence
Переопределяет:: toString в классе Object
Возвращает:: строку

first

public char first()

Устанавливает позицию на getBeginIndex() и возвращает символ в этой позиции.

Задано в:

first в интерфейсе CharacterIterator

Возвращает:

первый символ в тексте или DONE, если текст пустой

С тех пор как:

1.3

См. также:

last

public char last()

Устанавливает позицию на getEndIndex()-1 (getEndIndex(), если текст пустой) и возвращает символ в этой позиции.

Задано в:

last в интерфейсе CharacterIterator

Возвращает:

последний символ в тексте или DONE, если текст пустой

С тех пор как:

1.3

См. также:

current

public char current()

Получает символ в текущей позиции (как возвращается getIndex()).

Задано в:

current в интерфейсе CharacterIterator

Возвращает:

символ в текущей позиции или DONE, если текущая позиция находится за концом текста.

С тех пор как:

1.3

См. также:

public char next()

Увеличивает индекс итератора на единицу и возвращает символ в новой позиции. Если новая позиция больше или равна getEndIndex(), текущий индекс сбрасывается до getEndIndex(), и возвращается значение DONE.

Задано в:: next в интерфейсе CharacterIterator
Возвращает:: символ в новой позиции или DONE, если новая позиция находится за концом диапазона текста.
С тех пор как:: 1.3

public char previous()

Уменьшает индекс итератора на единицу и возвращает символ в новой позиции. Если текущий индекс равен getBeginIndex(), индекс остаётся равным getBeginIndex(), и возвращается значение DONE.

Задано в:: previous в интерфейсе CharacterIterator
Возвращает:: символ в новой позиции или DONE, если текущая позиция равна getBeginIndex().
С тех пор как:: 1.3

setIndex

public char setIndex(int position)

Устанавливает позицию на указанную позицию в тексте и возвращает этот символ.

Задано в:: setIndex в интерфейсе CharacterIterator
Параметры:: position - позиция в тексте. Допустимые значения находятся в диапазоне от getBeginIndex() до getEndIndex(). Если передано недопустимое значение, выбрасывается исключение IllegalArgumentException.
Возвращает:: символ в указанной позиции или DONE, если указанная позиция равна getEndIndex()
С тех пор как:: 1.3

getBeginIndex

public int getBeginIndex()

Возвращает начальный индекс текста.

Задано в:: getBeginIndex в интерфейсе CharacterIterator
Возвращает:: индекс начала текста.
С тех пор как:: 1.3

getEndIndex

public int getEndIndex()

Возвращает конечный индекс текста. Этот индекс — индекс первого символа, следующего за концом текста.

Задано в:: getEndIndex в интерфейсе CharacterIterator
Возвращает:: индекс после последнего символа в тексте
С тех пор как:: 1.3

getIndex

public int getIndex()

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

Задано в:: getIndex в интерфейсе CharacterIterator
Возвращает:: текущий индекс.
С тех пор как:: 1.3

charAt

public char charAt(int index)

Возвращает значение char в указанном индексе. Индекс изменяется от нуля до length() - 1. Первое значение char последовательности находится в индексе ноль, следующее — в индексе один и так далее, как при индексировании массивов.

Если значение char , указанное индексом, является замещающим символом, возвращается значение замещающего символа.

Задано в:: charAt в интерфейсе CharSequence
Параметры:: index - индекс возвращаемого значения char
Возвращает:: указанное значение char
С тех пор как:: 1.6

length

public int length()

Возвращает длину этого последовательности символов. Длина — количество 16-битных char в последовательности.

Задано в:: length в интерфейсе CharSequence
Возвращает:: количество char в этой последовательности
С тех пор как:: 1.6

subSequence

public CharSequence subSequence(int start, int end)

Возвращает CharSequence , являющуюся подпоследовательностью этой последовательности. Подпоследовательность начинается со значения char в указанном индексе и заканчивается значением char в индексе end - 1. Длина (в chars) возвращаемой последовательности равна end - start, поэтому, если start == end , возвращается пустая последовательность.

Задано в:: subSequence в интерфейсе CharSequence
Параметры:: start - начальный индекс, включительно; end - конечный индекс, исключая
Возвращает:: указанную подпоследовательность
С тех пор как:: 1.6

clone

public Object clone()

Создаёт поверхностную копию.

Задано в:

clone в интерфейсе CharacterIterator

Переопределяет:

clone в классе Object

Возвращает:

копию

См. также:

© 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/Segment.html