core/io.matthewnelson.encoding.core/EncoderDecoder/Config

Config

abstract class Config(val isLenient: Boolean?, lineBreakInterval: Byte, val paddingChar: Char?)(source)

Base configuration for an EncoderDecoder. More options may be specified by the implementing class.

Parameters

isLenient

If true, decoding will skip over spaces and new lines ('\n', '\r', ' ', '\t'). If false, an EncodingException will be thrown when encountering those characters. If null, those characters are passed along to Decoder.Feed.consumeProtected.

lineBreakInterval

If greater than 0 and isLenient is not false (i.e. is null or true), new lines will be output at the expressed lineBreakInterval when encoding.

paddingChar

The character that would be used when padding the encoded output; NOT "if padding should be used". If the encoding specification does not use padding, pass null.

Constructors

Config

constructor(isLenient: Boolean?, lineBreakInterval: Byte, paddingChar: Char?)

Types

Companion

object Companion

Setting

protected inner class Setting(name: String, val value: Any?)

Additional setting to Config, unique to the implementing class. Used in the toString output

Properties

isLenient

@JvmField

val isLenient: Boolean?

lineBreakInterval

@JvmField

val lineBreakInterval: Byte

paddingChar

@JvmField

val paddingChar: Char?

Functions

decodeOutMaxSize

fun decodeOutMaxSize(encodedSize: Long): Long

Pre-calculates and returns the maximum size of the output, after decoding would occur, for input that is not yet known (i.e. cannot be wrapped in DecoderInput, such as the contents of a File where only the file size is known) based off of the Config options set for the implementation.

decodeOutMaxSizeOrFail

fun decodeOutMaxSizeOrFail(input: DecoderInput): Int

Pre-calculates and returns the maximum size of the output, after decoding would occur, for input that is known based off of the Config options set for the implementation.

decodeOutMaxSizeOrFailProtected

protected abstract fun decodeOutMaxSizeOrFailProtected(encodedSize: Int, input: DecoderInput): Int

Will only receive values greater than 0.

decodeOutMaxSizeProtected

protected abstract fun decodeOutMaxSizeProtected(encodedSize: Long): Long

Will only receive values greater than 0.

encodeOutSize

fun encodeOutSize(unEncodedSize: Long): Long

Pre-calculates and returns the size of the output, after encoding would occur, based off of the Config options set.

fun encodeOutSize(unEncodedSize: Long, lineBreakInterval: Byte): Long

Pre-calculates and returns the size of the output, after encoding would occur, based off of the Config options set and expressed lineBreakInterval.

encodeOutSizeProtected

protected abstract fun encodeOutSizeProtected(unEncodedSize: Long): Long

Will only receive values greater than 0.

toStringAddSettings

protected abstract fun toStringAddSettings(): Set<EncoderDecoder.Config.Setting>

Will be called whenever toString is invoked, allowing inheritors of Config to add their settings to the output.