Class DocumentCharacterIterator

java.lang.Object

edu.umd.cs.findbugs.sourceViewer.DocumentCharacterIterator

All Implemented Interfaces:

Cloneable, CharacterIterator

public class DocumentCharacterIterator
extends Object
implements CharacterIterator

A CharacterIterator over a Document. Only a partial implementation.

Field Summary

Fields

Modifier and Type	Field	Description
private final Document	doc
private int	docPos	Position of iterator in document.
private int	segmentEnd	Index of end of current segment in document.
private final Segment	text

Fields inherited from interface CharacterIterator

DONE

Constructor Summary

Constructors

Constructor	Description
DocumentCharacterIterator(Document doc)

Method Summary

Modifier and Type	Method	Description
Object	clone()
char	current()
char	first()
int	getBeginIndex()
int	getEndIndex()
int	getIndex()
char	last()
char	next()	Increments the iterator's index by one and returns the character at the new index.
char	previous()
char	setIndex(int position)

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

doc

private final Document doc

text

private final Segment text

docPos

private int docPos

Position of iterator in document.

segmentEnd

private int segmentEnd

Index of end of current segment in document.

Constructor Details

DocumentCharacterIterator

DocumentCharacterIterator(Document doc)

Method Details

clone

public Object clone()

Specified by:

clone in interface CharacterIterator

Overrides:

clone in class Object

current

public char current()

Specified by:

current in interface CharacterIterator

first

public char first()

Specified by:

first in interface CharacterIterator

getBeginIndex

public int getBeginIndex()

Specified by:

getBeginIndex in interface CharacterIterator

getEndIndex

public int getEndIndex()

Specified by:

getEndIndex in interface CharacterIterator

getIndex

public int getIndex()

Specified by:

getIndex in interface CharacterIterator

last

public char last()

Specified by:

last in interface CharacterIterator

next

public char next()

Increments the iterator's index by one and returns the character at the new index.

Specified by:

next in interface CharacterIterator

Returns:

the character at the new position, or DONE if the new position is off the end

previous

public char previous()

Specified by:

previous in interface CharacterIterator

setIndex

public char setIndex(int position)

Specified by:

setIndex in interface CharacterIterator