cvs commit: jakarta-turbine-3/src/tool/org/apache/turbine/tool LocalizationService.java

[dl...@apache.org]

dlr         01/09/04 16:41:39

  Added:       src/tool/org/apache/turbine/tool LocalizationService.java
  Log:
  A pull tool which provides lookups for localized text by delegating to
  the configured LocalizationService.
  
  Revision  Changes    Path
  1.1                  jakarta-turbine-3/src/tool/org/apache/turbine/tool/LocalizationService.java
  
  Index: LocalizationService.java
  ===================================================================
  package org.apache.turbine.tool;
  
  /* ====================================================================
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2001 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution,
   *    if any, must include the following acknowledgment:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowledgment may appear in the software itself,
   *    if and wherever such third-party acknowledgments normally appear.
   *
   * 4. The names "Apache" and "Apache Software Foundation" and
   *    "Apache Turbine" must not be used to endorse or promote products
   *    derived from this software without prior written permission. For
   *    written permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache",
   *    "Apache Turbine", nor may "Apache" appear in their name, without
   *    prior written permission of the Apache Software Foundation.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  
  import java.util.ResourceBundle;
  import javax.servlet.http.HttpServletRequest;
  
  import org.apache.fulcrum.localization.Localization;
  
  import org.apache.turbine.services.pull.ApplicationTool;
  
  /**
   * A pull tool which provides lookups for localized text by delegating
   * to the configured <code>LocalizationService</code>.
   *
   * @author <a href="mailto:dlr@collab.net">Daniel Rall</a>
   * @author <a href="mailto:jon@collab.net">Jon Stevens</a>
   */
  public class LocalizationTool extends ApplicationTool
  {
      private HttpServletRequest req;
  
      private ResourceBundle bundle;
  
      /**
       * Creates a new instance.  Used by <code>PullService</code>.
       */
      public LocalizationTool()
      {
          refresh();
      }
  
      /**
       * <p>Performs text lookups for localization.</p>
       *
       * <p>Assuming there is a instance of this class in your
       * template's context named <code>l10n</code>, the following will
       * localize text for existing resource bundles:</p>
       *
       * <blockquote><code><pre>
       * ${l10n.HELLO}
       * </pre>
       *
       * <pre>
       * hello
       * </pre>
       *
       * <pre>
       * hola
       * </pre></code></blockquote>
       *
       * @param key The identifier for the localized text to retrieve.
       * @return The localized text.
       */
      public String get(String key)
      {
          if (bundle == null)
          {
              bundle = Localization.getBundle(req);
          }
          return Localization.getString(req, key);
      }
  
  
      // ApplicationTool implmentation
  
      /**
       * Sets the request to get the <code>Accept-Language</code> header
       * from.
       */
      public void init(Object data)
      {
          if (data instanceof RunData)
          {
              this.req = ((RunData) data).getRequest();
          }
      }
  
      /**
       * No-op.
       */
      public void refresh()
      {
          req = null;
          bundle = null;
      }
  }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: turbine-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: turbine-dev-help@jakarta.apache.org