Wanakana

object Wanakana

Core Wanakana functions.

Functions

isHiragana

@JvmStatic()

fun isHiragana(input: Char): Boolean

Returns true if input is Hiragana.

@JvmStatic()

fun isHiragana(input: String): Boolean

Returns true if input is Hiragana.

isJapanese

@JvmStatic()

fun isJapanese(input: Char): Boolean

Returns true if input only includes Kanji, Kana, zenkaku numbers, and JA punctuation/symbols.

@JvmStatic()

@JvmOverloads()

fun isJapanese(input: String, allowed: Regex? = null): Boolean

Returns true if input only includes Kanji, Kana, zenkaku numbers, and JA punctuation/symbols.

isKana

@JvmStatic()

fun isKana(input: Char): Boolean

Returns true if input is Kana.

@JvmStatic()

fun isKana(input: String): Boolean

Returns true if input is Kana.

isKanji

@JvmStatic()

fun isKanji(input: Char): Boolean

Returns true if input is Kanji.

@JvmStatic()

fun isKanji(input: String): Boolean

Returns true if input is Kanji.

isKatakana

@JvmStatic()

fun isKatakana(input: Char): Boolean

Returns true if input is Katakana.

@JvmStatic()

fun isKatakana(input: String): Boolean

Returns true if input is Katakana.

isMixed

@JvmStatic()

@JvmOverloads()

fun isMixed(input: String, passKanji: Boolean = true): Boolean

Returns true if input contains a mix of Romaji and Kana.

isRomaji

@JvmStatic()

fun isRomaji(input: Char): Boolean

Returns true if input is Romaji (allowing Hepburn romanisation).

@JvmStatic()

@JvmOverloads()

fun isRomaji(input: String, allowed: Regex? = null): Boolean

Returns true if input is Romaji (allowing Hepburn romanisation).

stripOkurigana

@JvmStatic()

@JvmOverloads()

fun stripOkurigana(input: String, leading: Boolean = false, matchKanji: String? = null): String

Strips Okurigana.

toHiragana

@JvmStatic()

fun toHiragana(input: String, config: Config = Config.DEFAULT): String

Converts input to Hiragana.

@JvmStatic()

@JvmOverloads()

fun toHiragana(input: String, imeMode: IMEMode = IMEMode.DISABLED, passRomaji: Boolean = false, useObsoleteKana: Boolean = false): String

Converts input to Hiragana.

toKana

@JvmStatic()

fun toKana(input: String, config: Config = Config.DEFAULT): String

Converts Romaji to Kana.

@JvmStatic()

@JvmOverloads()

fun toKana(input: String, imeMode: IMEMode = IMEMode.DISABLED, useObsoleteKana: Boolean = false): String

Converts Romaji to Kana.

toKanaIme

@JvmStatic()

fun toKanaIme(input: ImeText, config: Config = Config.DEFAULT_IME): ImeText

Converts Romaji to Kana and preserves the cursor/selection.

@JvmStatic()

@JvmOverloads()

fun toKanaIme(input: ImeText, imeMode: IMEMode = IMEMode.ENABLED, useObsoleteKana: Boolean = false): ImeText

Converts Romaji to Kana and preserves the cursor/selection.

toKatakana

@JvmStatic()

fun toKatakana(input: String, config: Config = Config.DEFAULT): String

Converts input to Katakana.

@JvmStatic()

@JvmOverloads()

fun toKatakana(input: String, imeMode: IMEMode = IMEMode.DISABLED, passRomaji: Boolean = false, useObsoleteKana: Boolean = false): String

Converts input to Katakana.

tokenize

@JvmStatic()

@JvmOverloads()

fun tokenize(input: String, compact: Boolean = false): List<String>

Splits input into a list of strings separated by opinionated TokenTypes.

tokenizeWithType

@JvmStatic()

@JvmOverloads()

fun tokenizeWithType(input: String, compact: Boolean = false): List<TypedToken>

Splits input into a list of tokens separated by opinionated TokenTypes.

toRomaji

@JvmStatic()

fun toRomaji(input: String, config: Config = Config.DEFAULT): String

Converts kana to romaji (Hepburn romanisation).

@JvmStatic()

@JvmOverloads()

fun toRomaji(input: String, imeMode: IMEMode = IMEMode.DISABLED, upcaseKatakana: Boolean = false): String

Converts kana to romaji (Hepburn romanisation).

toRomajiIme

@JvmStatic()

fun toRomajiIme(input: ImeText, config: Config = Config.DEFAULT_IME): ImeText

Converts kana to romaji (Hepburn romanisation), and preserves the cursor/selection.

@JvmStatic()

@JvmOverloads()

fun toRomajiIme(input: ImeText, imeMode: IMEMode = IMEMode.ENABLED, upcaseKatakana: Boolean = false): ImeText

Converts kana to romaji (Hepburn romanisation), and preserves the cursor/selection.