Package gw.gosudoc.com.sun.tools.javadoc.main

Class DocLocale

  • @Deprecated
class DocLocale
extends java.lang.Object
    Deprecated.
    This class holds the information about locales.

    This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

    Since:
    1.4

    • Field Summary

      Fields 
      Modifier and Type Field Description
      (package private) java.text.Collator collator
      Deprecated.
      The collator for this application.
      private DocEnv docenv
      Deprecated.
      Enclosing DocEnv
      (package private) java.util.Locale locale
      Deprecated.
      The locale to be used.
      (package private) java.lang.String localeName
      Deprecated.
      The locale name will be set by Main, if option is provided on the command line.
      private java.text.BreakIterator sentenceBreaker
      Deprecated.
      Sentence instance from the BreakIterator.
      (package private) static java.lang.String[] sentenceTerminators
      Deprecated.
      The HTML sentence terminators.
      private boolean useBreakIterator
      Deprecated.
      True is we should use BreakIterator to compute first sentence.

    • Constructor Summary

      Constructors 
      Constructor Description
      DocLocale​(DocEnv docenv, java.lang.String localeName, boolean useBreakIterator)
      Deprecated.
      Constructor

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      private java.lang.String englishLanguageFirstSentence​(java.lang.String s)
      Deprecated.
      Return the first sentence of a string, where a sentence ends with a period followed be white space.
      private java.util.Locale getLocale()
      Deprecated.
      Get the locale if specified on the command line else return null and if locale option is not used then return default locale.
      private boolean htmlSentenceTerminatorFound​(java.lang.String str, int index)
      Deprecated.
      Find out if there is any HTML tag in the given string.
      (package private) java.lang.String localeSpecificFirstSentence​(DocImpl doc, java.lang.String s)
      Deprecated.
       
      private java.util.Locale searchLocale​(java.lang.String language, java.lang.String country, java.lang.String variant)
      Deprecated.
      Search the locale for specified language, specified country and specified variant.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • localeName

        final java.lang.String localeName
        Deprecated.
        The locale name will be set by Main, if option is provided on the command line.

      • locale

        final java.util.Locale locale
        Deprecated.
        The locale to be used. If user doesn't provide this, then set it to default locale value.

      • collator

        final java.text.Collator collator
        Deprecated.
        The collator for this application. This is to take care of Locale Specific or Natural Language Text sorting.

      • docenv

        private final DocEnv docenv
        Deprecated.
        Enclosing DocEnv

      • sentenceBreaker

        private final java.text.BreakIterator sentenceBreaker
        Deprecated.
        Sentence instance from the BreakIterator.

      • useBreakIterator

        private boolean useBreakIterator
        Deprecated.
        True is we should use BreakIterator to compute first sentence.

      • sentenceTerminators

        static final java.lang.String[] sentenceTerminators
        Deprecated.
        The HTML sentence terminators.

    • Constructor Detail

      • DocLocale

        DocLocale​(DocEnv docenv,
          java.lang.String localeName,
          boolean useBreakIterator)
        Deprecated.
        Constructor

    • Method Detail

      • getLocale

        private java.util.Locale getLocale()
        Deprecated.
        Get the locale if specified on the command line else return null and if locale option is not used then return default locale.

      • searchLocale

        private java.util.Locale searchLocale​(java.lang.String language,
                                      java.lang.String country,
                                      java.lang.String variant)
        Deprecated.
        Search the locale for specified language, specified country and specified variant.

      • localeSpecificFirstSentence

        java.lang.String localeSpecificFirstSentence​(DocImpl doc,
                                             java.lang.String s)
        Deprecated.

      • englishLanguageFirstSentence

        private java.lang.String englishLanguageFirstSentence​(java.lang.String s)
        Deprecated.
        Return the first sentence of a string, where a sentence ends with a period followed be white space.

      • htmlSentenceTerminatorFound

        private boolean htmlSentenceTerminatorFound​(java.lang.String str,
                                            int index)
        Deprecated.
        Find out if there is any HTML tag in the given string. If found return true else return false.