CollationElementIterator (Java Platform SE 8 )

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 ruleBasedCollator = (RuleBasedCollator)col;
      CollationElementIterator collationElementIterator = ruleBasedCollator.getCollationElementIterator(testString);
      int primaryOrder = CollationElementIterator.primaryOrder(collationElementIterator.next());
          :
  }
 
```
CollationElementIterator.next返回下一个字符的排序顺序。排序规则由一级、二级和三级组成。的排序顺序的数据类型是int。排序规则的前16位是它的一阶；下一个8位是二阶，最后的8位是第三阶。

注： CollationElementIterator是RuleBasedCollator实现的一部分。这是唯一可用RuleBasedCollator实例。
另请参见：

Collator， RuleBasedCollator

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`NULLORDER` 指示字符串的结束的空顺序是由光标到达的。

方法摘要

所有方法静态方法接口方法具体的方法
Modifier and Type	Method and Description
`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)` 将迭代器指向对应于指定字符的排序规则元素（该参数是原始字符串中的一个字符偏移量，而不是一个偏移量为其相应的排序规则元素的顺序）。
`void`	`setText(CharacterIterator source)` 设置一个新的字符串来进行迭代。
`void`	`setText(String source)` 设置一个新的字符串来进行迭代。
`static short`	`tertiaryOrder(int order)` 返回排序元素的第三组件。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NULLORDER
```
public static final int NULLORDER
```
    指示字符串的结束的空顺序是由光标到达的。
    
    另请参见：
    
    Constant Field Values
- 方法详细信息
  - reset
```
public void reset()
```
    将光标移到字符串的开头。对next()下次调用将返回字符串中第一个排序元素。
  - next
```
public int next()
```
    获取字符串中的下一个排序规则元素。
    这个迭代器遍历一个序列的排序的元素，都是由字符串。因为不一定是从字符到排序元素的一对一的映射，这并不意味着“返回字符串中的下一个字符的排序元素[或排序优先级]相同的东西”。
    
    此函数返回当前指向的迭代器指向的排序规则元素，然后更新指向下一个元素的内部指针。previous()更新指针先返回元素。这意味着，当你改变方向而迭代（即电话next()然后调用previous()，或致电previous()然后调用next()），你会回来的一元二次。
    
    结果
    
    下一个排序规则元素
  - previous
```
public int previous()
```
    获取字符串中的以前的排序规则元素。
    这个迭代器遍历一个序列的排序的元素，都是由字符串。因为不一定是一个从字符到排序元素的一对一的映射，这并不意味着“返回字符串中以前的字符的排序规则元素[或排序优先级]”。
    
    这一功能更新对象的内部指针指向前一个目前指向排序元素并返回的元素，而next()返回当前元素并更新指针。这意味着，当你改变方向而迭代（即电话next()然后调用previous()，或致电previous()然后调用next()），你会回来的一元二次。
    
    结果
    
    以前的排序规则元素
    
    从以下版本开始：
    
    一点二
  - 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 -新的字符偏移量为原始文本。
    
    从以下版本开始：
    
    一点二
  - getOffset
```
public int getOffset()
```
    在对应于下一个排序规则元素的原始文本中返回字符偏移量。（那是，getoffset()返回对应排序元素，会对next()。下一次调用返回的文本的位置）这个值会相应排序元素的第一个字符的索引（缔约的字符序列是当两个或更多的人物都对应相同的排序元素）。这意味着，如果你setoffset（x）紧接getoffset()，getoffset()不会返回X。
    
    结果
    
    在相应的排序元素，将返回下一个电话next()原文本的字符偏移量。
    
    从以下版本开始：
    
    一点二
  - getMaxExpansion
```
public int getMaxExpansion(int order)
```
    用指定的比较顺序返回结束的任何扩展序列的最大长度。
    
    参数
    
    order -排序顺序返回上一个或下一个。
    
    结果
    
    以指定顺序结束的任何扩展序列的最大长度。
    
    从以下版本开始：
    
    一点二
  - setText
```
public void setText(String source)
```
    设置一个新的字符串来进行迭代。
    
    参数
    
    source -新的源文本
    
    从以下版本开始：
    
    一点二
  - setText
```
public void setText(CharacterIterator source)
```
    设置一个新的字符串来进行迭代。
    
    参数
    
    source -新的源文本。
    
    从以下版本开始：
    
    一点二

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2014, Oracle and/or its affiliates. All rights reserved.

Class CollationElementIterator

Field Summary

方法摘要

Methods inherited from class java.lang.Object

Field Detail

NULLORDER

方法详细信息

reset

next

previous

primaryOrder

secondaryOrder

tertiaryOrder

setOffset

getOffset

getMaxExpansion

setText

setText