Class MessageResourcesTool

  • Direct Known Subclasses:
    ActionMessagesTool, MessageTool

    public abstract class MessageResourcesTool
    extends java.lang.Object

    Abstract view tool that provides access to Struts' message resources.

    Since:
    VelocityTools 1.1
    Version:
    $Id: MessageResourcesTool.java 595822 2007-11-16 21:07:51Z nbubna $
    Author:
    Nathan Bubna
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected ServletContext application  
      private java.util.Locale locale  
      protected org.apache.velocity.runtime.log.Log LOG  
      protected HttpServletRequest request  
      private MessageResources resources  
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void configure​(java.util.Map params)
      Initializes this tool.
      protected java.util.Locale getLocale()
      Retrieves the Locale for this request.
      protected MessageResources getResources​(java.lang.String bundle)
      Retrieves the specified MessageResources bundle, or the application's default MessageResources if no bundle is specified.
      void init​(java.lang.Object obj)
      Deprecated.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • LOG

        protected org.apache.velocity.runtime.log.Log LOG
      • application

        protected ServletContext application
      • request

        protected HttpServletRequest request
      • locale

        private java.util.Locale locale
      • resources

        private MessageResources resources
    • Constructor Detail

      • MessageResourcesTool

        public MessageResourcesTool()
    • Method Detail

      • init

        @Deprecated
        public void init​(java.lang.Object obj)
        Deprecated.
      • configure

        public void configure​(java.util.Map params)
        Initializes this tool.
        Parameters:
        params - the Map of configuration parameters
        Throws:
        java.lang.IllegalArgumentException - if the param is not a ViewContext
      • getLocale

        protected java.util.Locale getLocale()
        Retrieves the Locale for this request.
        Since:
        VelocityTools 2.0
      • getResources

        protected MessageResources getResources​(java.lang.String bundle)
        Retrieves the specified MessageResources bundle, or the application's default MessageResources if no bundle is specified.
        Since:
        VelocityTools 1.1