Интерфейс CharacterIterator

public interface CharacterIterator extends Cloneable

Этот интерфейс определяет протокол для двусторонней итерации по тексту. Итератор проходит по ограниченной последовательности символов. Символы индексируются значениями, начиная с значения, возвращаемого getBeginIndex(), и продолжая до значения, возвращаемого getEndIndex()-1.

Итераторы сохраняют текущий индекс символа, допустимый диапазон которого от getBeginIndex() до getEndIndex(); значение getEndIndex() включается для обработки текстовых диапазонов нулевой длины и по историческим причинам. Текущий индекс можно получить, вызвав getIndex(), и установить напрямую, вызвав setIndex(), first(), и last().

Методы previous() и next() используются для итерации. Они возвращают DONE, если они выйдут за пределы диапазона от getBeginIndex() до getEndIndex() -1, сигнализируя о том, что итератор достиг конца последовательности. DONE также возвращается другими методами, чтобы указать, что текущий индекс находится за пределами этого диапазона.

Примеры:

Проход по тексту с начала до конца

 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.previous()) {
         processChar(c);
     }
 }
 

Проход как вперёд, так и назад от заданной позиции в тексте. Вызовы notBoundary() в этом примере представляют некоторые дополнительные критерии остановки.

 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.previous()) {
     }
     int start = iter.getIndex();
     processSection(start, end);
 }