com.ibm.as400.data.XmlException 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
The newest version!
///////////////////////////////////////////////////////////////////////////////
//
// JTOpen (IBM Toolbox for Java - OSS version)
//
// Filename: XmlException.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-2002 International Business Machines Corporation and
// others. All rights reserved.
//
///////////////////////////////////////////////////////////////////////////////

package com.ibm.as400.data;


/**
 * Thrown when an error is encountered processing XML.
 */
public class XmlException extends Exception
{
	private String         m_localizedMessage;
	private Exception      m_exception;

    /**
     * Constructs a XmlException without a user message.
     */
    XmlException()
	{
		super();
    }

    /**
     * Constructs a XmlException with a user message.
     *
     * @param   key   the resource key for the message string
     */
    XmlException(String key)
    {
        super();
        m_localizedMessage = SystemResourceFinder.format(key);
    }

    /**
     * Constructs a XmlException with a user message and substitution values.
     *
     * @param   key   The resource key for the message string
     * @param   args  Array of substitution values
     */
    XmlException(String key, Object[] args)
    {
        super();
        m_localizedMessage = SystemResourceFinder.format(key, args);
    }

    /**
     * Constructs a XmlException with another exception.
	 *
     * @param   e   the exception wrapped by the XmlException
     */
    XmlException(Exception e)
	{
	    super(e);

        // Try to load a string using the exception's Class name as the key
        m_localizedMessage = SystemResourceFinder.getString(e.getClass().getName());

        // If there is no string for this exception, use a generic "Exception received" message.
        if (m_localizedMessage == null)
        {
            m_localizedMessage = SystemResourceFinder.format(DAMRI.EXCEPTION_RECEIVED, new Object[] { "["+e.getClass().getName()+"] " + e.getLocalizedMessage()});
        }

		m_exception = e;
    }

    /**
     * Returns a localized description of this XmlException.
     */
	public String getLocalizedMessage()
	{
		if (m_localizedMessage != null)
			return m_localizedMessage;

		return super.getLocalizedMessage();
	}

    /**
     * Returns a description of this XmlException.
     */
	public String getMessage()
	{
          return getLocalizedMessage();
	}

    /**
     * Returns the original exception that caused this XmlException.
     * This method returns the same object as Exception.getCause().
     *
     * @return The exception that caused this instance of XmlException.
     * Note: This may be an instance of {@link PcmlSpecificationException PcmlSpecificationException}.
     * If this exception was not caused by another exception, null is returned.
     */
	public Exception getException()
	{
	    return m_exception;
	}
}