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 and Description
static Comparator<Rule.Phoneme>	COMPARATOR

Constructor Summary

Constructors

Constructor and 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 and Description
Rule.Phoneme	append(CharSequence str)
Languages.LanguageSet	getLanguages()
Iterable<Rule.Phoneme>	getPhonemes()
CharSequence	getPhonemeText()
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.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Field Detail

COMPARATOR

public static final Comparator<Rule.Phoneme> COMPARATOR

Constructor Detail

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 Detail

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()

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

toString

public String toString()

Description copied from class: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.