Class Hyphenator


  • public class Hyphenator
    extends Object
    This class is the main entry point to the hyphenation package. You can use only the static methods or create an instance.
    Author:
    Carlos Villegas
    • Constructor Detail

      • Hyphenator

        public Hyphenator​(String lang,
                          String country,
                          int leftMin,
                          int rightMin)
        Parameters:
        lang -
        country -
        leftMin -
        rightMin -
    • Method Detail

      • getHyphenationTree

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

        public static HyphenationTree getResourceHyphenationTree​(String key)
        Parameters:
        key -
        Returns:
        a hyphenation tree
      • getFileHyphenationTree

        public static HyphenationTree getFileHyphenationTree​(String key)
        Parameters:
        key -
        Returns:
        a hyphenation tree
      • hyphenate

        public static Hyphenation hyphenate​(String lang,
                                            String country,
                                            String word,
                                            int leftMin,
                                            int rightMin)
        Parameters:
        lang -
        country -
        word -
        leftMin -
        rightMin -
        Returns:
        a hyphenation object
      • hyphenate

        public static Hyphenation hyphenate​(String lang,
                                            String country,
                                            char[] word,
                                            int offset,
                                            int len,
                                            int leftMin,
                                            int rightMin)
        Parameters:
        lang -
        country -
        word -
        offset -
        len -
        leftMin -
        rightMin -
        Returns:
        a hyphenation object
      • setMinRemainCharCount

        public void setMinRemainCharCount​(int min)
        Parameters:
        min -
      • setMinPushCharCount

        public void setMinPushCharCount​(int min)
        Parameters:
        min -
      • setLanguage

        public void setLanguage​(String lang,
                                String country)
        Parameters:
        lang -
        country -
      • hyphenate

        public Hyphenation hyphenate​(char[] word,
                                     int offset,
                                     int len)
        Parameters:
        word -
        offset -
        len -
        Returns:
        a hyphenation object
      • hyphenate

        public Hyphenation hyphenate​(String word)
        Parameters:
        word -
        Returns:
        a hyphenation object
      • getHyphenDir

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

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