CollationElementIterator (Платформа Java SE 7)

java.lang. Объект
- java.text. CollationElementIterator

```
public final class CollationElementIterator
extends Object
```
CollationElementIterator класс используется в качестве iterator, чтобы идти через каждый символ международной строки. Используйте iterator, чтобы возвратить приоритет упорядочивания расположенного символа. Приоритет упорядочивания символа, который мы именуем как ключ, определяет, как символ сопоставляется в данном объекте сопоставления.
Например, рассмотрите следующее на испанском языке:
```
 "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 соответственно гарантировать правильность значения ключа.
Пример iterator использования,
```
  String testString = "This is a test";
  Collator col = Collator.getInstance();
  if (col instanceof RuleBasedCollator) {
      RuleBasedCollator ruleBasedCollator = (RuleBasedCollator)col;
      CollationElementIterator collationElementIterator = ruleBasedCollator.getCollationElementIterator(testString);
      int primaryOrder = CollationElementIterator.primaryOrder(collationElementIterator.next());
          :
  }
 
```
CollationElementIterator.next возвращает порядок сопоставления следующего символа. Порядок сопоставления состоит из основного порядка, вторичного порядка и третичного порядка. Тип данных порядка сопоставления является интервалом. Первые 16 битов порядка сопоставления являются его основным порядком; следующие 8 битов являются вторичным порядком, и последние 8 битов третичный порядок.
Отметьте: CollationElementIterator часть RuleBasedCollator реализация. Это только применимо с RuleBasedCollator экземпляры.
См. Также:
Collator, RuleBasedCollator

Полевая Сводка

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

Сводка метода

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

Методы java.lang унаследованный от класса. Объект
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Полевая Деталь
  - NULLORDER
```
public static final int NULLORDER
```
    Нулевой порядок, который указывает на конец строки, достигается курсором.
    
    См. Также:
    Постоянные Значения полей
- Деталь метода
  - сброс
```
public void reset()
```
    Сбрасывает курсор к началу строки. Следующий звонок затем () возвратит первый элемент сопоставления в строке.
  - затем
```
public int next()
```
    Получите следующий элемент сопоставления в строке.
    Этот iterator выполняет итерации по последовательности элементов сопоставления, которые были созданы из строки. Поскольку есть не обязательно непосредственное отображение от символов до элементов сопоставления, это не означает ту же самую вещь как "возврат элемент сопоставления [или приоритет упорядочивания] следующего символа в строке".
    
    Эта функция возвращает элемент сопоставления, на который iterator в настоящий момент указывает и затем обновляет внутренний указатель, чтобы указать на следующий элемент. предыдущий () обновляет указатель сначала и затем возвращает элемент. Это означает, что, когда Вы изменяете направление, выполняя итерации (то есть, вызовите затем () и затем вызовите предыдущий (), или вызовите предыдущий () и затем вызовите затем ()), Вы возвратите тот же самый элемент дважды.
  - предыдущий
```
public int previous()
```
    Получите предыдущий элемент сопоставления в строке.
    Этот iterator выполняет итерации по последовательности элементов сопоставления, которые были созданы из строки. Поскольку есть не обязательно непосредственное отображение от символов до элементов сопоставления, это не означает ту же самую вещь как "возврат элемент сопоставления [или приоритет упорядочивания] предыдущего символа в строке".
    
    Эта функция обновляет внутренний указатель iterator, чтобы указать на элемент сопоставления, предшествующий тому, на который это в настоящий момент указывает и затем возвращает тот элемент, в то время как затем () возвращает текущий элемент и затем обновляет указатель. Это означает, что, когда Вы изменяете направление, выполняя итерации (то есть, вызовите затем () и затем вызовите предыдущий (), или вызовите предыдущий () и затем вызовите затем ()), Вы возвратите тот же самый элемент дважды.
    
    С тех пор:
    
    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)
```
    Устанавливает iterator, чтобы указать на элемент сопоставления, соответствующий указанному символу (параметр является СИМВОЛЬНЫМ смещением в исходной строке, не смещением в его соответствующую последовательность элементов сопоставления). Значение, возвращенное следующим звонком затем (), будет элементом сопоставления, соответствующим указанной позиции в тексте. Если та позиция находится в середине сокращающейся символьной последовательности, результатом следующего звонка затем () является элемент сопоставления для той последовательности. Это означает, что getOffset (), как гарантируют, не возвратит то же самое значение, как был передан к предыдущему звонку setOffset ().
    
    Параметры:
    newOffset - Новое символьное смещение в оригинальный текст.
    С тех пор:
    
    1.2
  - getOffset
```
public int getOffset()
```
    Возвращает символьное смещение в оригинальном тексте, соответствующем следующему элементу сопоставления. (Таким образом, getOffset () возвращает позицию в тексте, соответствующем элементу сопоставления, который будет возвращен следующим звонком затем ()). Это значение всегда будет индексом ПЕРВОГО символа, соответствующего элементу сопоставления (сокращающаяся символьная последовательность - то, когда два или больше символа все соответствуют тому же самому элементу сопоставления). Это означает, делаете ли Вы setOffset (x) сопровождаемый сразу getOffset (), getOffset () не обязательно возвратит x.
    
    Возвраты:
    Символьное смещение в оригинальном тексте, соответствующем элементу сопоставления, который будет возвращен следующим звонком затем ().
    С тех пор:
    
    1.2
  - getMaxExpansion
```
public int getMaxExpansion(int order)
```
    Возвратите максимальную длину любых последовательностей расширения, которые заканчиваются указанным порядком сравнения.
    
    Параметры:
    order - порядок сопоставления, возвращенный предыдущим или следующим.
    
    Возвраты:
    максимальная длина любых последовательностей расширения, заканчивающихся указанным порядком.
    С тех пор:
    
    1.2
  - setText
```
public void setText(String source)
```
    Установите новую строку, по которой можно выполнить итерации.
    
    Параметры:
    source - новый исходный текст
    С тех пор:
    
    1.2
  - setText
```
public void setText(CharacterIterator source)
```
    Установите новую строку, по которой можно выполнить итерации.
    
    Параметры:
    source - новый исходный текст.
    С тех пор:
    
    1.2

Представьте ошибку или функцию
Для дальнейшей ссылки API и документации разработчика, см. Java Документация SE. Та документация содержит более подробные, предназначенные разработчиком описания, с концептуальными краткими обзорами, определениями сроков, обходных решений, и рабочих примеров кода.
Авторское право © 1993, 2011, Oracle и/или его филиалы. Все права защищены.

Класс CollationElementIterator

Полевая Сводка

Сводка метода

Методы java.lang унаследованный от класса. Объект

Полевая Деталь

NULLORDER

Деталь метода

сброс

затем

предыдущий

primaryOrder

secondaryOrder

tertiaryOrder

setOffset

getOffset

getMaxExpansion

setText

setText