jakarta.jms.MessageFormatRuntimeException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

The newest version!

/*
 * Copyright (c) 2011, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.jms;

/**
 * This unchecked exception must be thrown when a Jakarta Messaging application attempts to use a data type not supported by a message
 * or attempts to read data in a message as the wrong type, and the method signature does not permit a
 * {@code MessageFormatException} to be thrown.
 *
 * 
 * It must also be thrown when equivalent type errors are made with message
 * property values. Note that the special case of a failure caused by an attempt to read improperly formatted
 * {@code String} data as numeric values must throw the {@code java.lang.NumberFormatException}.
 *
 * @version Jakarta Messaging 2.0
 * @since JMS 2.0
 *
 **/
public class MessageFormatRuntimeException extends JMSRuntimeException {

    /**
     * Explicitly set serialVersionUID to be the same as the implicit serialVersionUID of the Jakarta Messaging 2.0 version
     */
    private static final long serialVersionUID = 416918643772467720L;

    /**
     * Constructs a {@code MessageFormatRuntimeException} with the specified detail message
     *
     * @param detailMessage a description of the exception
     **/
    public MessageFormatRuntimeException(String detailMessage) {
        super(detailMessage);
    }

    /**
     * Constructs a {@code MessageFormatRuntimeException} with the specified detail message and error code.
     *
     * @param detailMessage a description of the exception
     * @param errorCode a provider-specific error code
     **/
    public MessageFormatRuntimeException(String detailMessage, String errorCode) {
        super(detailMessage, errorCode);
    }

    /**
     * Constructs a {@code MessageFormatRuntimeException} with the specified detail message, error code and cause
     *
     * @param detailMessage a description of the exception
     * @param errorCode a provider-specific error code
     * @param cause the underlying cause of this exception
     */
    public MessageFormatRuntimeException(String detailMessage, String errorCode, Throwable cause) {
        super(detailMessage, errorCode, cause);
    }
}