StringCharacterIterator (central-repository 4.0.0-RC API)

java.lang.Object
- org.apache.regexp.StringCharacterIterator

All Implemented Interfaces:: CharacterIterator

public final class StringCharacterIterator
extends Object
implements CharacterIterator

Encapsulates String as CharacterIterator.

Constructor Summary

Constructors
Constructor Description

StringCharacterIterator(String src)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`char`	`charAt(int pos)`
`boolean`	`isEnd(int pos)`
`String`	`substring(int beginIndex)`
`String`	`substring(int beginIndex, int endIndex)`

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

- Constructor Detail
  - StringCharacterIterator
```
public StringCharacterIterator(String src)
```
    Parameters:
    
    src - - encapsulated String
- Method Detail
  - substring
```
public String substring(int beginIndex,
                        int endIndex)
```
    Specified by:
    
    substring in interface CharacterIterator
    
    Returns:
    
    a substring
  - substring
```
public String substring(int beginIndex)
```
    Specified by:
    
    substring in interface CharacterIterator
    
    Returns:
    
    a substring
  - charAt
```
public char charAt(int pos)
```
    Specified by:
    
    charAt in interface CharacterIterator
    
    Returns:
    
    a character at the specified position.
  - isEnd
```
public boolean isEnd(int pos)
```
    Specified by:
    
    isEnd in interface CharacterIterator
    
    Returns:
    
    true iff if the specified index is after the end of the character stream