org.apache.commons.chain.web
Class AbstractSetLocaleCommand

java.lang.Object
  extended by org.apache.commons.chain.web.AbstractSetLocaleCommand
All Implemented Interfaces:
Command
Direct Known Subclasses:
FacesSetLocaleCommand, PortletSetLocaleCommand, ServletSetLocaleCommand

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

Abstract base Command implementation for setting the response locale for this response to the Locale stored under the context attribute key returned by the localeKey property.

Version:
$Revision: 1.5 $ $Date: 2004/02/25 00:01:06 $
Author:
Craig R. McClanahan

Field Summary
private  java.lang.String localeKey
          The context attribute key used to retrieve the Locale.
 
Constructor Summary
AbstractSetLocaleCommand()
           
 
Method Summary
 boolean execute(Context context)
          Retrieve the Locale stored under the specified context attribute key, and establish it on this response.
 java.lang.String getLocaleKey()
          Return the context attribute key under which we will retrieve the response Locale.
protected abstract  void setLocale(Context context, java.util.Locale locale)
          Establish the specified Locale for this response.
 void setLocaleKey(java.lang.String localeKey)
          Set the context attribute key under which we will retrieve the response 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 retrieve the Locale.

Constructor Detail

AbstractSetLocaleCommand

public AbstractSetLocaleCommand()
Method Detail

getLocaleKey

public java.lang.String getLocaleKey()

Return the context attribute key under which we will retrieve the response Locale.


setLocaleKey

public void setLocaleKey(java.lang.String localeKey)

Set the context attribute key under which we will retrieve the response Locale.

Parameters:
localeKey - The new context attribute key

execute

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

Retrieve the Locale stored under the specified context attribute key, and establish it on this response.

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 - general purpose exception return to indicate abnormal termination
java.lang.IllegalArgumentException - if context is null

setLocale

protected abstract void setLocale(Context context,
                                  java.util.Locale locale)

Establish the specified Locale for this response.