Класс CollationElementIterator

java.lang.Object

java.text.CollationElementIterator

public final class CollationElementIterator extends Object

Класс CollationElementIterator используется в качестве итератора для прохода по каждому символу международной строки. Используйте итератор для возвращения приоритета упорядочения позиционированного символа. Приоритет упорядочения символа, который мы называем ключом, определяет, как символ сортируется в данном объекте сортировки.

Например, рассмотрим следующий случай на испанском языке:

 "ca" → the first key is key('c') and second key is key('a').
 "cha" → the first key is key('ch') and second key is key('a').

А на немецком языке,

 "Ã¤b" → the first key is key('a'), the second key is key('e'), and
 the third key is key('b').

Ключ символа — это целое число, состоящее из первичного порядка (короткое), вторичного порядка (байт) и третичного порядка (байт). Java строго определяет размер и знаковый разряд своих примитивных типов данных. Поэтому статические функции primaryOrder, secondaryOrder, и tertiaryOrder возвращают соответственно int, short, и short, чтобы обеспечить корректность значения ключа.

Пример использования итератора:

String testString = "This is a test";
Collator col = Collator.getInstance();
if (col instanceof RuleBasedCollator ruleBasedCollator) {
    CollationElementIterator collationElementIterator = ruleBasedCollator.getCollationElementIterator(testString);
    int primaryOrder = CollationElementIterator.primaryOrder(collationElementIterator.next());
        â®
}

CollationElementIterator.next возвращает порядок сортировки следующего символа. Порядок сортировки состоит из первичного, вторичного и третичного порядка. Тип данных порядка сортировки — int. Первые 16 бит порядка сортировки — это первичный порядок; следующие 8 бит — вторичный порядок, а последние 8 бит — третичный порядок.

Примечание: CollationElementIterator является частью реализации RuleBasedCollator. Он используется только с экземплярами RuleBasedCollator.

Since:

1.1

See Also:

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

Модификатор и тип	Поле	Описание
`static final int`	`NULLORDER`	Нулевой порядок, который указывает на то, что курсор достиг конца строки.

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

Модификатор и тип	Метод	Описание
`int`	`getMaxExpansion(int order)`	Возвращает максимальную длину любых последовательностей расширения, которые заканчиваются указанным порядком сравнения.
`int`	`getOffset()`	Возвращает смещение символа в исходном тексте, соответствующее следующему элементу сортировки.
`int`	`next()`	Получает следующий элемент сортировки в строке.
`int`	`previous()`	Получает предыдущий элемент сортировки в строке.
`static final int`	`primaryOrder(int order)`	Возвращает первичную компоненту элемента сортировки.
`void`	`reset()`	Сбрасывает курсор в начало строки.
`static final short`	`secondaryOrder(int order)`	Возвращает вторичную компоненту элемента сортировки.
`void`	`setOffset(int newOffset)`	Устанавливает итератор на указанный элемент сортировки. (Параметр — это смещение символа в исходной строке, а не смещение в соответствующей последовательности элементов сортировки).
`void`	`setText(String source)`	Устанавливает новую строку для итерации.
`void`	`setText(CharacterIterator source)`	Устанавливает новую строку для итерации.
`static final short`	`tertiaryOrder(int order)`	Возвращает третичную компоненту элемента сортировки.

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

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

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

NULLORDER

public static final int NULLORDER

Нулевой порядок, указывающий на достижение конца строки курсором.

См. также:

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

reset

public void reset()

Сбрасывает курсор к началу строки. Следующий вызов next() вернёт первый элемент сортировки в строке.

public int next()

Получение следующего элемента сортировки в строке.

Этот итератор перебирает последовательность элементов сортировки, построенных из строки. Поскольку не обязательно существует взаимно однозначное соответствие между символами и элементами сортировки, это не означает то же, что «вернуть элемент сортировки [или приоритет упорядочения] следующего символа в строке».

Эта функция возвращает элемент сортировки, на который в данный момент указывает итератор, и затем обновляет внутренний указатель, чтобы он указывал на следующий элемент. previous() обновляет указатель сначала, а затем возвращает элемент. Это означает, что при изменении направления при итерации (т. е. вызов next(), а затем вызов previous(), или вызов previous(), а затем вызов next()), вы получите тот же элемент дважды.

Возвращает:: следующий элемент сортировки

public int previous()

Получение предыдущего элемента сортировки в строке.

Этот итератор перебирает последовательность элементов сортировки, построенных из строки. Поскольку не обязательно существует взаимно однозначное соответствие между символами и элементами сортировки, это не означает то же, что «вернуть элемент сортировки [или приоритет упорядочения] предыдущего символа в строке».

Эта функция обновляет внутренний указатель итератора, чтобы он указывал на элемент сортировки, предшествующий текущему, и затем возвращает этот элемент, в то время как next() возвращает текущий элемент и затем обновляет указатель. Это означает, что при изменении направления при итерации (т. е. вызов next() и затем вызов previous(), или вызов previous() и затем вызов next()), вы получите тот же элемент дважды.

Возвращает:: предыдущий элемент сортировки
С тех пор как:: 1.2

primaryOrder

public static final int primaryOrder(int order)

Возвращает первичную составляющую элемента сортировки.

Параметры:: order - элемент сортировки
Возвращает:: первичную составляющую элемента

secondaryOrder

public static final short secondaryOrder(int order)

Возвращает вторичную составляющую элемента сортировки.

Параметры:: order - элемент сортировки
Возвращает:: вторичную составляющую элемента

tertiaryOrder

public static final short tertiaryOrder(int order)

Возвращает третичную составляющую элемента сортировки.

Параметры:: order - элемент сортировки
Возвращает:: третичную составляющую элемента

setOffset

public void setOffset(int newOffset)

Устанавливает итератор для указания на элемент сортировки, соответствующий указанному символу (параметр — смещение символа в исходной строке, а не смещение в соответствующей последовательности элементов сортировки). Значение, возвращаемое следующим вызовом next(), будет элементом сортировки, соответствующим указанной позиции в тексте. Если эта позиция находится в середине последовательности сокращающихся символов, результатом следующего вызова next() является элемент сортировки для этой последовательности. Это означает, что getOffset() не гарантирует возврат того же значения, что и при предыдущем вызове setOffset().

Параметры:: newOffset - Новое смещение символа в исходном тексте.
С тех пор как:: 1.2

getOffset

public int getOffset()

Возвращает смещение символа в исходном тексте, соответствующее следующему элементу сортировки. (То есть getOffset() возвращает позицию в тексте, соответствующую элементу сортировки, который будет возвращён следующим вызовом next().) Это значение всегда будет индексом ПЕРВОГО символа, соответствующего элементу сортировки (последовательность сокращающихся символов — когда два или более символов соответствуют одному элементу сортировки). Это означает, что если вы вызываете setOffset(x) сразу после getOffset(), getOffset() необязательно вернёт x.

Возвращает:: Смещение символа в исходном тексте, соответствующее элементу сортировки, который будет возвращён следующим вызовом next().
С тех пор как:: 1.2

getMaxExpansion

public int getMaxExpansion(int order)

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

Параметры:: order - порядок сортировки, возвращённый функциями previous или next.
Возвращает:: максимальная длина любых расширяющих последовательностей, заканчивающихся указанным порядком.
С тех пор как:: 1.2

setText

public void setText(String source)

Устанавливает новую строку для итерации.

Параметры:: source - новый исходный текст
С тех пор как:: 1.2

setText

public void setText(CharacterIterator source)

Устанавливает новую строку для итерации.

Параметры:: source - новый исходный текст.
С тех пор как:: 1.2

© 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.base/java/text/CollationElementIterator.html