Package org.apache.manifoldcf.core.i18n

Class Messages

  • Direct Known Subclasses:
    Messages
    public class Messages
extends java.lang.Object

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      protected static class  Messages.BundleKey
      Class to help keep track of the missing resource bundles we've already complained about, so we don't fill up the standard out log with repetitive stuff.
      protected static class  Messages.MessageKey
      Class to help keep track of the missing messages we've already complained about, so we don't fill up the standard out log with repetitive stuff.
      protected static class  Messages.ResourceKey
      Class to help keep track of the missing resources we've already complained about, so we don't fill up the standard out log with repetitive stuff.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected Messages()
      Constructor - do no instantiate

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      protected static void complainMissingBundle​(java.lang.String errorMessage, java.lang.Throwable exception, java.lang.String bundleName, java.util.Locale locale)  
      protected static void complainMissingMessage​(java.lang.String errorMessage, java.lang.Throwable exception, java.lang.String bundleName, java.util.Locale locale, java.lang.String messageKey)  
      protected static void complainMissingResource​(java.lang.String errorMessage, java.lang.Throwable exception, java.lang.String pathName, java.util.Locale locale, java.lang.String resourceKey)  
      static org.apache.velocity.app.VelocityEngine createVelocityEngine​(java.lang.Class classInstance)
      Create and initialize a velocity engine instance, given a class.
      static java.lang.String getMessage​(java.lang.Class clazz, java.lang.String bundleName, java.util.Locale locale, java.lang.String messageKey)
      Obtain a message given a resource bundle and message key.
      static java.lang.String getMessage​(java.util.ResourceBundle resources, java.lang.String bundleName, java.util.Locale locale, java.lang.String messageKey)
      Obtain a message given a resource bundle and message key.
      static java.io.InputStream getResourceAsStream​(java.lang.Class classInstance, java.lang.String pathName, java.util.Locale originalLocale, java.lang.String resourceKey)
      Read a resource as an input stream, given a class, path, locale, and resource key.
      static java.util.ResourceBundle getResourceBundle​(java.lang.Class clazz, java.lang.String bundleName, java.util.Locale locale)
      Obtain a resource bundle given a class, bundle name, and locale.
      static java.lang.String getString​(java.lang.Class clazz, java.lang.String bundleName, java.util.Locale locale, java.lang.String messageKey, java.lang.Object[] args)
      Obtain a string given a class, bundle, locale, message key, and arguments.
      static java.lang.String getString​(java.util.ResourceBundle resourceBundle, java.lang.String bundleName, java.util.Locale locale, java.lang.String messageKey)
      Obtain a string given a resource bundle and message key.
      static java.lang.String getString​(java.util.ResourceBundle resourceBundle, java.lang.String bundleName, java.util.Locale locale, java.lang.String messageKey, java.lang.Object[] args)
      Obtain a string given a resource bundle, message key, and arguments.
      protected static void logError​(java.lang.String errorMessage, java.lang.Throwable exception)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Messages

        protected Messages()
        Constructor - do no instantiate

    • Method Detail

      • createVelocityEngine

        public static org.apache.velocity.app.VelocityEngine createVelocityEngine​(java.lang.Class classInstance)
                                                                   throws ManifoldCFException
        Create and initialize a velocity engine instance, given a class.
        Throws:
        ManifoldCFException

      • getResourceAsStream

        public static java.io.InputStream getResourceAsStream​(java.lang.Class classInstance,
                                                      java.lang.String pathName,
                                                      java.util.Locale originalLocale,
                                                      java.lang.String resourceKey)
                                               throws ManifoldCFException
        Read a resource as an input stream, given a class, path, locale, and resource key.
        Throws:
        ManifoldCFException

      • getResourceBundle

        public static java.util.ResourceBundle getResourceBundle​(java.lang.Class clazz,
                                                         java.lang.String bundleName,
                                                         java.util.Locale locale)
        Obtain a resource bundle given a class, bundle name, and locale.
        Returns:
        null if the resource bundle could not be found.

      • getMessage

        public static java.lang.String getMessage​(java.lang.Class clazz,
                                          java.lang.String bundleName,
                                          java.util.Locale locale,
                                          java.lang.String messageKey)
        Obtain a message given a resource bundle and message key.
        Returns:
        null if the message could not be found.

      • getMessage

        public static java.lang.String getMessage​(java.util.ResourceBundle resources,
                                          java.lang.String bundleName,
                                          java.util.Locale locale,
                                          java.lang.String messageKey)
        Obtain a message given a resource bundle and message key.
        Returns:
        null if the message could not be found.

      • getString

        public static java.lang.String getString​(java.util.ResourceBundle resourceBundle,
                                         java.lang.String bundleName,
                                         java.util.Locale locale,
                                         java.lang.String messageKey)
        Obtain a string given a resource bundle and message key.

      • getString

        public static java.lang.String getString​(java.lang.Class clazz,
                                         java.lang.String bundleName,
                                         java.util.Locale locale,
                                         java.lang.String messageKey,
                                         java.lang.Object[] args)
        Obtain a string given a class, bundle, locale, message key, and arguments.

      • getString

        public static java.lang.String getString​(java.util.ResourceBundle resourceBundle,
                                         java.lang.String bundleName,
                                         java.util.Locale locale,
                                         java.lang.String messageKey,
                                         java.lang.Object[] args)
        Obtain a string given a resource bundle, message key, and arguments.

      • complainMissingBundle

        protected static void complainMissingBundle​(java.lang.String errorMessage,
                                            java.lang.Throwable exception,
                                            java.lang.String bundleName,
                                            java.util.Locale locale)

      • complainMissingMessage

        protected static void complainMissingMessage​(java.lang.String errorMessage,
                                             java.lang.Throwable exception,
                                             java.lang.String bundleName,
                                             java.util.Locale locale,
                                             java.lang.String messageKey)

      • complainMissingResource

        protected static void complainMissingResource​(java.lang.String errorMessage,
                                              java.lang.Throwable exception,
                                              java.lang.String pathName,
                                              java.util.Locale locale,
                                              java.lang.String resourceKey)

      • logError

        protected static void logError​(java.lang.String errorMessage,
                               java.lang.Throwable exception)