Class Rule.Phoneme
- java.lang.Object
-
- org.apache.commons.codec.language.bm.Rule.Phoneme
-
- All Implemented Interfaces:
Rule.PhonemeExpr
- Enclosing class:
- Rule
public static final class Rule.Phoneme extends java.lang.Object implements Rule.PhonemeExpr
A phoneme.
-
-
Field Summary
Fields Modifier and Type Field Description static java.util.Comparator<Rule.Phoneme>
COMPARATOR
The Phoneme Comparator.
-
Constructor Summary
Constructors Constructor Description Phoneme(java.lang.CharSequence phonemeText, Languages.LanguageSet languages)
Constructs a new instance.Phoneme(Rule.Phoneme phonemeLeft, Rule.Phoneme phonemeRight)
Constructs a new instance.Phoneme(Rule.Phoneme phonemeLeft, Rule.Phoneme phonemeRight, Languages.LanguageSet languages)
Constructs a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Rule.Phoneme
append(java.lang.CharSequence sequence)
Appends the sequence to the phone text.Languages.LanguageSet
getLanguages()
Gets the language set.java.lang.Iterable<Rule.Phoneme>
getPhonemes()
Gets an iteration of phonemes.java.lang.CharSequence
getPhonemeText()
Gets the phoneme text sequence.Rule.Phoneme
join(Rule.Phoneme right)
Deprecated.since 1.9Rule.Phoneme
mergeWithLanguage(Languages.LanguageSet lang)
Returns a new Phoneme with the same text but a union of its current language set and the given one.int
size()
Gets the expression size in phonemes.java.lang.String
toString()
-
-
-
Field Detail
-
COMPARATOR
public static final java.util.Comparator<Rule.Phoneme> COMPARATOR
The Phoneme Comparator.
-
-
Constructor Detail
-
Phoneme
public Phoneme(java.lang.CharSequence phonemeText, Languages.LanguageSet languages)
Constructs a new instance.- Parameters:
phonemeText
- The phoneme text.languages
- A language set.
-
Phoneme
public Phoneme(Rule.Phoneme phonemeLeft, Rule.Phoneme phonemeRight)
Constructs a new instance.- Parameters:
phonemeLeft
- The left phoneme text.phonemeRight
- The right phoneme text.
-
Phoneme
public Phoneme(Rule.Phoneme phonemeLeft, Rule.Phoneme phonemeRight, Languages.LanguageSet languages)
Constructs a new instance.- Parameters:
phonemeLeft
- The left phoneme text.phonemeRight
- The right phoneme text.languages
- A language set.
-
-
Method Detail
-
append
public Rule.Phoneme append(java.lang.CharSequence sequence)
Appends the sequence to the phone text.- Parameters:
sequence
- The sequence to append.- Returns:
- this instance.
-
getLanguages
public Languages.LanguageSet getLanguages()
Gets the language set.- Returns:
- the language set.
-
getPhonemes
public java.lang.Iterable<Rule.Phoneme> getPhonemes()
Description copied from interface:Rule.PhonemeExpr
Gets an iteration of phonemes.- Specified by:
getPhonemes
in interfaceRule.PhonemeExpr
- Returns:
- an iteration of phonemes.
-
getPhonemeText
public java.lang.CharSequence getPhonemeText()
Gets the phoneme text sequence.- Returns:
- the phoneme text sequence.
-
join
@Deprecated public Rule.Phoneme join(Rule.Phoneme right)
Deprecated.since 1.9Deprecated since 1.9.- Parameters:
right
- the Phoneme to join- Returns:
- a new Phoneme
-
mergeWithLanguage
public Rule.Phoneme mergeWithLanguage(Languages.LanguageSet lang)
Returns a new Phoneme with the same text but a union of its current language set and the given one.- Parameters:
lang
- the language set to merge- Returns:
- a new Phoneme
-
size
public int size()
Description copied from interface:Rule.PhonemeExpr
Gets the expression size in phonemes.- Specified by:
size
in interfaceRule.PhonemeExpr
- Returns:
- the expression size in phonemes.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-