Class AbstractGetLocaleCommand

  • All Implemented Interfaces:
    Command
    Direct Known Subclasses:
    PortletGetLocaleCommand, ServletGetLocaleCommand

    public abstract class AbstractGetLocaleCommand
    extends java.lang.Object
    implements Command

    Abstract base Command implementation for retrieving the requested Locale from our Context, and storing it under the context attribute key returned by the localeKey property.

    Version:
    $Revision: 480477 $ $Date: 2006-11-29 08:34:52 +0000 (Wed, 29 Nov 2006) $
    Author:
    Craig R. McClanahan
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      boolean execute​(Context context)
      Retrieve the Locale for this request, and store it under the specified context attribute.
      protected abstract java.util.Locale getLocale​(Context context)
      Retrieve and return the Locale for this request.
      java.lang.String getLocaleKey()
      Return the context attribute key under which we will store the request Locale.
      void setLocaleKey​(java.lang.String localeKey)
      Set the context attribute key under which we will store the request Locale.
      • Methods inherited from class java.lang.Object

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

      • localeKey

        private java.lang.String localeKey

        The context attribute key used to store the Locale.

    • Constructor Detail

      • AbstractGetLocaleCommand

        public AbstractGetLocaleCommand()
    • Method Detail

      • getLocaleKey

        public java.lang.String getLocaleKey()

        Return the context attribute key under which we will store the request Locale.

        Returns:
        The context attribute key of the request Locale.
      • setLocaleKey

        public void setLocaleKey​(java.lang.String localeKey)

        Set the context attribute key under which we will store the request Locale.

        Parameters:
        localeKey - The new context attribute key
      • execute

        public boolean execute​(Context context)
                        throws java.lang.Exception

        Retrieve the Locale for this request, and store it under the specified context attribute.

        Specified by:
        execute in interface Command
        Parameters:
        context - The Context we are operating on
        Returns:
        false so that processng will continue
        Throws:
        java.lang.Exception - If an error occurs during execution.
      • getLocale

        protected abstract java.util.Locale getLocale​(Context context)

        Retrieve and return the Locale for this request.

        Parameters:
        context - The Context we are operating on.
        Returns:
        The Locale for the request.