Package org.apache.fop.hyphenation
Class HyphenationTreeCache
java.lang.Object
org.apache.fop.hyphenation.HyphenationTreeCache
This is a cache for HyphenationTree instances.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
cache
(String key, HyphenationTree hTree) Cache a hyphenation tree under its key.static String
constructLlccKey
(String lang, String country) Constructs the key for the hyphenation pattern file.static String
constructUserKey
(String lang, String country, Map hyphPatNames) If the user configured a hyphenation pattern file name for this (lang,country) value, return it.getHyphenationTree
(String lang, String country) Looks in the cache if a hyphenation tree is available and returns it if it is found.boolean
Indicates whether a hyphenation file has been requested before but it wasn't available.void
noteMissing
(String key) Notes a key to a hyphenation tree as missing.
-
Constructor Details
-
HyphenationTreeCache
public HyphenationTreeCache()
-
-
Method Details
-
getHyphenationTree
Looks in the cache if a hyphenation tree is available and returns it if it is found.- Parameters:
lang
- the languagecountry
- the country (may be null or "none")- Returns:
- the HyhenationTree instance or null if it's not in the cache
-
constructLlccKey
Constructs the key for the hyphenation pattern file.- Parameters:
lang
- the languagecountry
- the country (may be null or "none")- Returns:
- the resulting key
-
constructUserKey
If the user configured a hyphenation pattern file name for this (lang,country) value, return it. If not, return null.- Parameters:
lang
- the languagecountry
- the country (may be null or "none")hyphPatNames
- the map of user-configured hyphenation pattern file names- Returns:
- the hyphenation pattern file name or null
-
cache
Cache a hyphenation tree under its key.- Parameters:
key
- the key (ex. "de_CH" or "en")hTree
- the hyphenation tree
-
noteMissing
Notes a key to a hyphenation tree as missing. This is to avoid searching a second time for a hyphenation pattern file which is not available.- Parameters:
key
- the key (ex. "de_CH" or "en")
-
isMissing
Indicates whether a hyphenation file has been requested before but it wasn't available. This is to avoid searching a second time for a hyphenation pattern file which is not available.- Parameters:
key
- the key (ex. "de_CH" or "en")- Returns:
- true if the hyphenation tree is unavailable
-