Skip to content

This is a library that converts Roman letters to both hiragana and katakana and vice versa.

License

shotadft/KanaConverter

Repository files navigation

KanaConverter

Forks Stargazers Issues Unlicense License Maven Central Version App Version

Overview

This is a library that converts Roman letters to both hiragana and katakana and vice versa.

Installation

Maven

<dependency>
    <groupId>com.shotadft</groupId>
    <artifactId>kana-converter</artifactId>
    <version>1.1.2</version>
</dependency>

Gradle(Groovy DSL)

dependencies {
    implementation 'com.shotadft:kana-converter:1.1.2'
}

Gradle(Kotlin DSL)

dependencies {
    implementation("com.shotadft:kana-converter:1.1.2")
}

Requirement

  • Java (21)
  • Kotlin (2.2.10)

Development Environments

  • IntelliJ IDEA Community Edition (2025.2)
  • Gradle (8.9)
    • dokka (2.0.0)
    • spotless (7.2.1)
  • Eclipse Temurin JDK (21.0.8+9)

Usage

import com.shotadft.kanaconverter.KanaConverter.toHiragana
import com.shotadft.kanaconverter.KanaConverter.toKatakana
import com.shotadft.kanaconverter.KanaConverter.toRomaji

fun main() {
    val hiragana = "こんにちは"
    val katakana = "コンニチハ"
    val romaji = "kon'nichiha"

    println(hiragana.toKatakana()) // コンニチハ
    
    println(hiragana.toRomaji())   // kon'nichiha
    println(katakana.toRomaji())   // kon'nichiha
    
    println(romaji.toHiragana())   // こんにちは
    println(romaji.toKatakana())   // コンニチハ
}

Features

  • 高速、そしてまあまあ高い精度で変換できます。
    対応してないものがあるかもしれないけどその場合はIssueを立ててね
    (ただし、ヘボンと訓令を両対応させる都合でtoRomajiの精度がかなり低いです...)
  • fastutilのマップを簡単に構築できるツールを使用してメモリ消費量を抑えています。
    また、キャッシュによって変換速度を向上させています。
  • IssueやPull Requestは大歓迎です。
    バグ報告、機能追加、コード改善など何でもどうぞ。

Author Links