Package org.apache.commons.codec.language.bm

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 Object
implements Rule.PhonemeExpr

Field Summary

Fields

Modifier and Type	Field	Description
static final Comparator<Rule.Phoneme>	COMPARATOR

Constructor Summary

Constructors

Constructor	Description
Phoneme(CharSequence phonemeText, Languages.LanguageSet languages)
Phoneme(Rule.Phoneme phonemeLeft, Rule.Phoneme phonemeRight)
Phoneme(Rule.Phoneme phonemeLeft, Rule.Phoneme phonemeRight, Languages.LanguageSet languages)

Method Summary

Modifier and Type	Method	Description
Rule.Phoneme	append(CharSequence str)
Languages.LanguageSet	getLanguages()
Iterable<Rule.Phoneme>	getPhonemes()
CharSequence	getPhonemeText()
Rule.Phoneme	join(Rule.Phoneme right)	Deprecated. since 1.9
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.
int	size()	Gets the expression size in phonemes.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

COMPARATOR

public static final Comparator<Rule.Phoneme> COMPARATOR

Constructor Details

Phoneme

public Phoneme(CharSequence phonemeText,
 Languages.LanguageSet languages)

Phoneme

public Phoneme(Rule.Phoneme phonemeLeft,
 Rule.Phoneme phonemeRight)

Phoneme

public Phoneme(Rule.Phoneme phonemeLeft,
 Rule.Phoneme phonemeRight,
 Languages.LanguageSet languages)

Method Details

append

public Rule.Phoneme append(CharSequence str)

getLanguages

public Languages.LanguageSet getLanguages()

getPhonemes

public Iterable<Rule.Phoneme> getPhonemes()

Specified by:

getPhonemes in interface Rule.PhonemeExpr

getPhonemeText

public CharSequence getPhonemeText()

join

@Deprecated
public Rule.Phoneme join(Rule.Phoneme right)

Deprecated.

since 1.9

Deprecated 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 interface Rule.PhonemeExpr

Returns:

the expression size in phonemes.

toString

public String toString()

Overrides:

toString in class Object