kiteqr/io.github.yuroyami.kiteqr.common/ECIInput

ECIInput

Interface to navigate a sequence of ECIs and bytes.

Inheritors

Functions

abstract fun charAt(index: Int): Char

Returns the byte value at the specified index. An index ranges from zero to length() - 1. The first byte value of the sequence is at index zero, the next at index one, and so on, as for array indexing.

getECIValue

abstract fun getECIValue(index: Int): Int

Returns the int ECI value at the specified index. An index ranges from zero to length() - 1. The first byte value of the sequence is at index zero, the next at index one, and so on, as for array indexing.

haveNCharacters

abstract fun haveNCharacters(index: Int, n: Int): Boolean

isECI

abstract fun isECI(index: Int): Boolean

Determines if a value is an ECI

length

abstract fun length(): Int

Returns the length of this input. The length is the number of bytes in or ECIs in the sequence.

subSequence

abstract fun subSequence(start: Int, end: Int): CharSequence

Returns a CharSequence that is a subsequence of this sequence. The subsequence starts with the char value at the specified index and ends with the char value at index end - 1. The length (in chars) of the returned sequence is end - start, so if start == end then an empty sequence is returned.