de.digitalcollections.solrocr.util

Class FileBytesCharIterator

java.lang.Object

de.digitalcollections.solrocr.util.FileBytesCharIterator

All Implemented Interfaces:

IterableCharSequence, CharSequence, Cloneable, CharacterIterator

public class FileBytesCharIterator
extends Object
implements IterableCharSequence

ATTENTION: This breaks the semantics of CharacterIterator and CharSequence since all indices are byte offsets into the underlying file, not character indices. All methods that don't operate on indices should work as expected. Please note that this means that this type will only work with BreakIterator types that don't mess with the index themselves.

Nested Class Summary

Nested classes/interfaces inherited from interface de.digitalcollections.solrocr.util.IterableCharSequence

IterableCharSequence.IterableStringCharSequence, IterableCharSequence.OffsetType

Field Summary

Fields inherited from interface java.text.CharacterIterator

DONE

Constructor Summary

Constructors

Constructor and Description
FileBytesCharIterator(FileBytesCharIterator other)
FileBytesCharIterator(Path path)
FileBytesCharIterator(Path path, Charset charset)

Method Summary

Modifier and Type	Method and Description
char	charAt(int offset) Get character at the given byte offset.
Object	clone()
char	current()
char	first()
int	getBeginIndex()
Charset	getCharset()
int	getEndIndex()
String	getIdentifier()
int	getIndex()
IterableCharSequence.OffsetType	getOffsetType()
char	last()
int	length()
char	next()
char	previous()
char	setIndex(int offset)
CharSequence	subSequence(int start, int end)

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.digitalcollections.solrocr.util.IterableCharSequence

fromString

Methods inherited from interface java.lang.CharSequence

chars, codePoints, toString

Constructor Detail

FileBytesCharIterator

public FileBytesCharIterator(Path path)
                      throws IOException

Throws:

IOException

FileBytesCharIterator

public FileBytesCharIterator(Path path,
                             Charset charset)
                      throws IOException

Throws:

IOException

FileBytesCharIterator

public FileBytesCharIterator(FileBytesCharIterator other)
                      throws IOException

Throws:

IOException

Method Detail

length

public int length()

Specified by:

length in interface CharSequence

charAt

public char charAt(int offset)

Get character at the given byte offset. Note that this will seek back if we're landing inside of a UTF-8 codepoint. Also, if the UTF-8 string results in an multi-char UTF-16 codepoint, this will return the first char if we're on the first to third byte of the UTF-8 sequence and the second char if we're on the fourth byte. (?? TODO correct ??)

Specified by:

charAt in interface CharSequence

subSequence

public CharSequence subSequence(int start,
                                int end)

Specified by:

subSequence in interface CharSequence

first

public char first()

Specified by:

first in interface CharacterIterator

last

public char last()

Specified by:

last in interface CharacterIterator

current

public char current()

Specified by:

current in interface CharacterIterator

next

public char next()

Specified by:

next in interface CharacterIterator

previous

public char previous()

Specified by:

previous in interface CharacterIterator

setIndex

public char setIndex(int offset)

Specified by:

setIndex 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

clone

public Object clone()

Specified by:

clone in interface CharacterIterator

Overrides:

clone in class Object

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in interface IterableCharSequence

getOffsetType

public IterableCharSequence.OffsetType getOffsetType()

Specified by:

getOffsetType in interface IterableCharSequence

getCharset

public Charset getCharset()

Specified by:

getCharset in interface IterableCharSequence