Класс 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 Поля
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
- См. также:
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()
next
public char next()
Увеличивает индекс итератора на единицу и возвращает символ в новой позиции. Если полученный индекс больше или равен getEndIndex(), текущий индекс сбрасывается до getEndIndex(), и возвращается значение DONE.
- Определено в:
-
nextв интерфейсеCharacterIterator - Возвращает:
- символ в новой позиции или DONE, если новая позиция находится за пределами диапазона текста.
- С:
- 1.3
previous
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. Длина (в char ) возвращаемой последовательности равна end - start, поэтому если start == end , то возвращается пустая последовательность.
- Определено в:
-
subSequenceв интерфейсеCharSequence - Параметры:
-
start- начальный индекс, включительно -
end- конечный индекс, исключая - Возвращает:
- указанную подпоследовательность
- С:
- 1.6
clone
public Object clone()
Создаёт поверхностную копию.
- Определено в:
-
cloneв интерфейсеCharacterIterator - Переопределяет:
-
cloneв классеObject - Возвращает:
- копию
- См. также:
Cloneable
© 1993, 2020, 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/11/docs/api/java.desktop/javax/swing/text/Segment.html