Package dev.enola.common.text

Class PronounceableText

java.lang.Object

dev.enola.common.text.LangString

dev.enola.common.text.PronounceableText

public final class PronounceableText
extends LangString

PronounceableText is a LangString plus a phonetic representation.

For example, the English word "hello" would be represented as "hello" and "həˈləʊ".

This allows it to be correctly pronounced by a text-to-speech synthesis engine, such as e.g. the (venerable!) eSpeak (try it e.g. on itinerarium's phoneme-synthesis), or Google Cloud Text-to-Speech AI or Amazon Polly (try it e.g. on ipa-reader.com), etc.

Both the idea and the specific class name PronounceableText were directly inspired by the https://schema.org/PronounceableText.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
static PronounceableText	of(String text, Locale language, String phonetic, SpeechMarkupForm phoneticForm)
String	phonetic()
SpeechMarkupForm	phoneticForm()
String	toString()

Methods inherited from class dev.enola.common.text.LangString

direction, language, of, of, text

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

of

public static PronounceableText of(String text,
 Locale language,
 String phonetic,
 SpeechMarkupForm phoneticForm)

phonetic

public String phonetic()

phoneticForm

public SpeechMarkupForm phoneticForm()

toString

public String toString()

Overrides:

toString in class LangString

hashCode

public int hashCode()

Overrides:

hashCode in class LangString

equals

public boolean equals(Object o)

Overrides:

equals in class LangString