net.sf.mmm.util.text.api

Interface HyphenatorBuilder

All Known Implementing Classes:

AbstractHyphenatorBuilder, HyphenatorBuilderImpl

@ComponentSpecification
public interface HyphenatorBuilder

This is the interface used to retrieve a Hyphenator for a given Locale .
An implementation has to be thread-safe.

Since:

2.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
Hyphenator	getHyphenator() This method gets the Hyphenator for the default locale.
Hyphenator	getHyphenator(Locale locale) This method gets the Hyphenator for the given Locale.

Method Detail

getHyphenator

Hyphenator getHyphenator()

This method gets the Hyphenator for the default locale.

Returns:

the according Hyphenator.

getHyphenator

Hyphenator getHyphenator(Locale locale)

This method gets the Hyphenator for the given Locale. If no hyphenation-rules are available for the given Locale, a Hyphenator for a more general Locale is build.

Parameters:

locale - is the Locale used to determine the hyphenation-rules for the according country and region.

Returns:

the according Hyphenator.