base32/io.matthewnelson.encoding.base32/Base32CrockfordConfigBuilder/finalizeWhenFlushed

finalizeWhenFlushed

@JvmField

var finalizeWhenFlushed: Boolean(source)

If true, whenever Encoder.Feed.flush is invoked:

The checkSymbol will be appended.
The counter for hyphenInterval insertion will be reset.

If false

Appendage of the checkSymbol will only occur when Encoder.Feed.doFinal is invoked.
The counter for hyphenInterval insertion will not be reset.

If neither checkSymbol or hyphenInterval are set, this has no effect when encoding.

e.g. (when false)

val sb = StringBuilder()
Base32Crockford {
    hyphenInterval = 4
    checkSymbol('*')
    finalizeWhenFlushed = false
}.newEncoderFeed { encodedChar ->
    sb.append(encodedChar)
}.use { feed ->
    bytes1.forEach { b -> feed.consume(b) }
    feed.flush()
    bytes2.forEach { b -> feed.consume(b) }
}

println(sb.toString())
// 91JP-RV3F-41BP-YWKC-CGGG-*

e.g. (when true)

val sb = StringBuilder()
Base32Crockford {
    hyphenInterval = 4
    checkSymbol('*')
    finalizeWhenFlushed = true
}.newEncoderFeed { encodedChar ->
    sb.append(encodedChar)
}.use { feed ->
    bytes1.forEach { b -> feed.consume(b) }
    feed.flush()

    // Could do something here like insert a line
    // break. It has its use cases.

    bytes2.forEach { b -> feed.consume(b) }
}

println(sb.toString())
// 91JP-RV3F-*41BP-YWKC-CGGG-*

Default: false