Класс 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)`	Возвращает значение в указанном индексе.
`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)`	Возвращает подпоследовательность этой последовательности.
`String`	`toString()`	Преобразует отрезок в строку.

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

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

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

chars, codePoints, isEmpty

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

array

public char[] array

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

смещение

public int offset

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

количество

public int count

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

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

Сегмент

public 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

См. также:

getBeginIndex()

last

public char last()

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

Определено в:

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

Возвращает:

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

С:

1.3

См. также:

getEndIndex()

current

public char current()

Возвращает символ в текущей позиции (возвращённой getIndex()).

Определено в:

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

Возвращает:

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

С:

1.3

См. также:

getIndex()

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

длина

public int length()

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

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

подпоследовательность

public CharSequence subSequence(int start, int end)

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

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

клонировать

public Object clone()

Создаёт неглубокую копию.

Определено в:

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

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

clone в классе Object

Возвращает:

копию

См. также:

Cloneable

© 1993, 2021, 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/17/docs/api/java.desktop/javax/swing/text/Segment.html