me.xx2bab.polyfill.arsc.base.IParsable.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of polyfill-arsc Show documentation

Hook Toolset for Android App Build System.

There is a newer version: 0.4.1

package me.xx2bab.polyfill.arsc.base

import me.xx2bab.polyfill.arsc.io.LittleEndianInputStream
import java.io.IOException

/**
 * To denote a class support parsing its properties from byte streams, and vice versa.
 */
interface IParsable {

    /**
     * To parse properties from byte stream for it self.
     * Do not call this function in a constructor since that is a bad practice to throw exception in constructors.
     *
     * Reference: https://stackoverflow.com/questions/6086334/is-it-good-practice-to-make-the-constructor-throw-an-exception/6086399
     */
    @Throws(IOException::class)
    fun parse(input: LittleEndianInputStream, start: Long)

    /**
     * To generate ByteArray of its exportable properties.
     * It's the reverse operation of parse(...) .
     */
    fun toByteArray(): ByteArray

}