src.com.ibm.as400.data.ResourceLoader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jt400 Show documentation
The Open Source version of the IBM Toolbox for Java
There is a newer version: 20.0.8
///////////////////////////////////////////////////////////////////////////////
//                                                                             
// JTOpen (IBM Toolbox for Java - OSS version)                              
//                                                                             
// Filename: ResourceLoader.java
//                                                                             
// The source code contained herein is licensed under the IBM Public License   
// Version 1.0, which has been approved by the Open Source Initiative.         
// Copyright (C) 1997-2000 International Business Machines Corporation and     
// others. All rights reserved.                                                
//                                                                             
///////////////////////////////////////////////////////////////////////////////

package com.ibm.as400.data;

import com.ibm.as400.access.Trace;                  // @A1A
import java.text.MessageFormat;
import java.util.*;

/**
 * A utility class which wrappers ResourceBundle
 * operations and handles exceptions gracefully.
 * For example, if a string resource
 * cannot be accessed, ResourceLoader returns
 * the string "RESOURCEMISSING", allowing the developer to
 * quickly detect the missing resource and correct the problem.
 */
class ResourceLoader extends Object
{
    private ResourceBundle m_bundle = null;

    /**
     * Sets the resource bundle name.
     *
     * setResourceName attempts to load the specified
     * resource bundle.  If an error occurs, an exception is logged
     * and appropriate action is taken on subsequent requests for
     * specific resources.
     *
     * @param name the name of the resource bundle to be loaded.
     * If the resource bundle could not be found, getString
     * will return the string "RESOURCE BUNDLE ERROR".
     */
    public void setResourceName(String name)
    {
        if (m_bundle == null)
        {
            try 
            { 
            	m_bundle = ResourceBundle.getBundle(name); 
            }
            catch (MissingResourceException e) 
            {
                Trace.log(Trace.ERROR, e);                  // @A1C
            }
        }
    }

    /**
     * Returns a locale-dependent string.
     *
     * getString looks for the string resource identified
     * by the specified key in the resource bundle specified on setResourceName.
     * If the string could not be found, getString
     * returns "RESOURCEMISSING".  If the resource bundle could not
     * be loaded, getString returns "RESOURCEBUNDLEERROR".
     *
     * @param key  the key which identifies the string to be loaded.
     * @return string resource
     */
    public String getString(String key)
    {
        if (m_bundle != null)
        {
            try
            {
                return m_bundle.getString(key);
            }
            catch (MissingResourceException e)
            {
                Trace.log(Trace.ERROR, e);                  // @A1C
                try 
                {
                    return MessageFormat.format(m_bundle.getString(DAMRI.MISSING_KEY), new Object[] {key});
                }
                catch (Exception eAgain) 
                {
                    return "RESOURCE BUNDLE ERROR.";
                }
            }
        }
        else 
            return "RESOURCE BUNDLE ERROR.";
    }

    /**
     * Returns a locale-dependent string.
     *
     * getString looks for the string resource identified
     * by the specified key in the resource bundle specified on setResourceName.
     * If the string could not be found, getString
     * returns "RESOURCEMISSING".  If the resource bundle could not
     * be loaded, getString returns "RESOURCEBUNDLEERROR".
     *
     * @param key  the key which identifies the string to be loaded.
     * @return string resource
     */
    public String getStringWithNoSubstitute(String key)
    {
        if (m_bundle != null)
        {
            try
            {
                return m_bundle.getString(key);
            }
            catch (MissingResourceException e)
            {
                return null;
            }
        }
        else 
            return null;
    }
}