Skip to content

kuon/java-base24

Repository files navigation

GitHub Workflow Status Version License

Base24 encoder/decoder for Java

This library is an encoder/decoder for the Base24 encoding written in Kotlin.

Usage

When using gradle (Kotlin DSL):

Add the repository:

repositories {
    maven {
        setUrl("https://maven.goyman.com")
    }
}

Add the following dependencies:

dependencies {
    // ...
    implementation("ch.kuon.commons:base24:0.1.1")
    // ...
}

Then the API is very simple:

object ch.kuon.commons.Base24

/**
 * Encode bytes to a string using base24
 * @param data A byte array. Length must be multiple of 4.
 * @return The encoded string
 */
fun encode24(data: ByteArray): String

/**
 * Decode a string to byte array using base24
 * @param data A string encoded un base24. Length must be multiple of 7
 * @return The decoded bytes
 */
fun decode24(data: String): ByteArray

Example

import ch.kuon.commons.Base24.encode24
import ch.kuon.commons.Base24.decode24

val bytes = byteArrayOf(1, 2, 3, 4)
val myString = encode24(bytes)

myString == "ZCCYBZB" // true

val decodedBytes = decode24("2Z42F6A")

decodedBytes contentEquals byteArrayOf(0x22, 0x55, 0x33, 0x11) // true

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

About

Encoder and decoder for the Base24 encoding

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published