Class Hyphenator


  • public class Hyphenator
    extends java.lang.Object
    This class is the main entry point to the hyphenation package. You can use only the static methods or create an instance.
    • Field Detail

      • defaultHyphLocation

        private static final java.lang.String defaultHyphLocation
        See Also:
        Constant Field Values
      • hyphenTrees

        private static java.util.Map<java.lang.String,​HyphenationTree> hyphenTrees
        TODO: Don't use statics
      • hyphenDir

        private static java.lang.String hyphenDir
        Holds value of property hyphenDir.
      • remainCharCount

        private int remainCharCount
      • pushCharCount

        private int pushCharCount
    • Constructor Detail

      • Hyphenator

        public Hyphenator​(java.lang.String lang,
                          java.lang.String country,
                          int leftMin,
                          int rightMin)
        Parameters:
        lang - The language
        country - the Country
        leftMin - The minimum letters on the left
        rightMin - The minimum letters on the right
    • Method Detail

      • getHyphenationTree

        public static HyphenationTree getHyphenationTree​(java.lang.String lang,
                                                         java.lang.String country)
        Parameters:
        lang - The language
        country - The country
        Returns:
        the hyphenation tree
      • getResourceHyphenationTree

        public static HyphenationTree getResourceHyphenationTree​(java.lang.String key)
        Parameters:
        key - A String of the key of the hyphenation tree
        Returns:
        a hyphenation tree
      • readHyphenationFile

        private static java.io.InputStream readHyphenationFile​(java.lang.String key)
      • getFileHyphenationTree

        public static HyphenationTree getFileHyphenationTree​(java.lang.String key)
        Parameters:
        key - The language to get the tree from
        Returns:
        a hyphenation tree or null
      • getHyphenFile

        private static java.io.File getHyphenFile​(java.lang.String key)
      • hyphenate

        public static Hyphenation hyphenate​(java.lang.String lang,
                                            java.lang.String country,
                                            java.lang.String word,
                                            int leftMin,
                                            int rightMin)
        Parameters:
        lang - The language
        country - The country
        word - char array containing the word
        leftMin - Minimum number of characters allowed before the hyphenation point
        rightMin - Minimum number of characters allowed after the hyphenation point
        Returns:
        a hyphenation object
      • hyphenate

        public static Hyphenation hyphenate​(java.lang.String lang,
                                            java.lang.String country,
                                            char[] word,
                                            int offset,
                                            int len,
                                            int leftMin,
                                            int rightMin)
        Parameters:
        lang - The language
        country - The country
        word - char array that contains the word to hyphenate
        offset - Offset to the first character in word
        len - The length of the word
        leftMin - Minimum number of characters allowed before the hyphenation point
        rightMin - Minimum number of characters allowed after the hyphenation point
        Returns:
        a hyphenation object
      • getHyphenDir

        public static java.lang.String getHyphenDir()
        Getter for property hyphenDir.
        Returns:
        Value of property hyphenDir.
      • setHyphenDir

        public static void setHyphenDir​(java.lang.String _hyphenDir)
        Setter for property hyphenDir.
        Parameters:
        _hyphenDir - New value of property hyphenDir.
      • setMinRemainCharCount

        public void setMinRemainCharCount​(int min)
        Parameters:
        min - Minimum number of characters allowed before the hyphenation point
      • setMinPushCharCount

        public void setMinPushCharCount​(int min)
        Parameters:
        min - Minimum number of characters allowed after the hyphenation point
      • setLanguage

        public void setLanguage​(java.lang.String lang,
                                java.lang.String country)
        Parameters:
        lang - The language
        country - The country
      • hyphenate

        public Hyphenation hyphenate​(char[] word,
                                     int offset,
                                     int len)
        Parameters:
        word - Char array that contains the word
        offset - Offset to the first character in word
        len - Length of the word
        Returns:
        a hyphenation object
      • hyphenate

        public Hyphenation hyphenate​(java.lang.String word)
        Parameters:
        word - The word to hyphenate
        Returns:
        a hyphenation object