类 java.text.StringCharacterIterator

java.lang.Object
   |
   +----java.text.StringCharacterIterator

public final class StringCharacterIterator

extends Object

implements CharacterIterator

StringCharacterIterator 为一个 String 实现了 CharacterIterater 协议。 StringCharacterIterator 类迭代全部的 String。

示例：

从开始到末尾遍历文本。

 public void traverseForward(CharacterIterator iter) {
     for (char c = iter.first(); c != CharacterIterator.DONE; c = iter.next()) {
         processChar(c);
     }
 }
 

 public void traverseBackward(CharacterIterator iter) {
     for (char c = iter.last(); c != CharacterIterator.DONE; c = iter.prev()) {
         processChar(c);
     }
 }
 

 public void traverseOut(CharacterIterator iter, int pos) {
     for (char c = iter.setIndex(pos);
          c != CharacterIterator.DONE && notBoundary(c);
          c = iter.next()) {}
     int end = iter.getIndex();
     for (char c = iter.setIndex(pos);
          c != CharacterIterator.DONE && notBoundary(c);
          c = iter.prev()) {}
     int start = iter.getIndex();
     processSection(iter.getText.subString(start,end);
 }
 

构造子索引

StringCharacterIterator(String)

用初始索引 0 构造一个迭代子。

StringCharacterIterator(String, int)

用指定的初始索引构造一个迭代子。

StringCharacterIterator(String, int, int, int)

用设置在指定位置的索引，在给定字符串的给定范围内构造一个迭代子。

方法索引

clone()

创建该边界的一个拷贝。

current()

获得当前位置的字符 ( 就象由 getIndex() 返回的字符 )。

equals(Object)

比较两个 StringCharacterIterator 对象是否相等。

first()

将位置设置为 getBeginIndex() 并返回该位置的字符。

getBeginIndex()

返回文本的开始位置索引。

getEndIndex()

返回文本的结束位置索引。

getIndex()

返回当前的位置索引。

hashCode()

计算该枚举数据的散列码。

last()

将位置设置为 getEndIndex() 并返回该位置的字符。

next()

将迭代子加一并返回新索引处的字符。

previous()

将迭代子减一并返回新索引处的字符。

setIndex(int)

将位置设置为文本中指定的位置并返回该字符。

构造子

 public StringCharacterIterator(String text)

用初始索引 0 构造一个迭代子。

 public StringCharacterIterator(String text,
                    int pos)

用指定的初始索引构造一个迭代子。

参数：

text - 要迭代的 String

pos - 初始的迭代子位置

 public StringCharacterIterator(String text,
                                int begin,
                                int end,
                    int pos)

用设置在指定位置的索引，在给定字符串的给定范围内构造一个迭代子。

参数：

text - 要迭代的 String

begin - 第一个字符的位置索引

end - 最后一个字符后面一个字符的位置索引

pos - 初始的迭代子位置

方法

 public char first()

将位置设置为 getBeginIndex() 并返回该位置的字符。

 public char last()

将位置设置为 getEndIndex() 并返回该位置的字符。

 public char setIndex(int p)

将位置设置为文本中指定的位置并返回该字符。

 public char current()

获得当前位置的字符 ( 就象由 getIndex() 返回的字符 )。

返回值：

返回当前位置的字符，如果当前位置超出了文本的末尾则返回 DONE 。

 public char next()

将迭代子的索引加一并返回新索引处的字符。 如果结果索引大于或等于 getEndIndex()，当前的索引设为 getEndIndex() 并返回 DONE。

返回值：

返回新位置的字符，如果当前位置超出了文本的末尾则返回 DONE 。

 public char previous()

将迭代子的位置索引一并返回新索引处的字符。 如果结果索引小于或等于 getBeginIndex()，将当前的索引设为 getBeginIndex() 并返回 DONE。

返回值：

返回新位置的字符，如果当前位置超出了文本的末尾则返回 DONE 。

 public int getBeginIndex()

返回文本的开始索引。

返回值：

文本开始的索引。

 public int getEndIndex()

返回文本的结束索引。 该索引是文本末尾后面第一个字符的索引。

返回值：

文本结束的索引。

 public int getIndex()

返回当前的索引。

返回值：

当前的索引。

 public boolean equals(Object obj)

比较两个 StringCharacterIterator 对象是否相等。

参数：

obj - 要比较的 StringCharacterIterator 对象。

返回值：

如果给定的 obj 与 StringCharacterIterator 对象相同则返回 true；否则返回 false。

覆盖：

类 Object 中的 equals

 public int hashCode()

计算该枚举数据的散列码。

返回值：

一个散列码

覆盖：

类 Object 中的 hashCode

 public Object clone()

创建该边界的一个拷贝。

返回值：

创建该边界的一个拷贝

覆盖：

类 Object 中的 clone