javax.xml.registry.RegistryException Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of javaee-api Show documentation
The newest version!
/*
* The contents of this file are subject to the terms 
* of the Common Development and Distribution License 
* (the License).  You may not use this file except in
* compliance with the License.
* 
* You can obtain a copy of the license at 
* https://glassfish.dev.java.net/public/CDDLv1.0.html or
* glassfish/bootstrap/legal/CDDLv1.0.txt.
* See the License for the specific language governing 
* permissions and limitations under the License.
* 
* When distributing Covered Code, include this CDDL 
* Header Notice in each file and include the License file 
* at glassfish/bootstrap/legal/CDDLv1.0.txt.  
* If applicable, add the following below the CDDL Header, 
* with the fields enclosed by brackets [] replaced by
* you own identifying information: 
* "Portions Copyrighted [year] [name of copyright owner]"
* 
* Copyright 2007 Sun Microsystems, Inc. All rights reserved.
*/

package javax.xml.registry;

import javax.xml.registry.infomodel.*;

/**
 * This is the common base class for all Exceptions that are detected on the registry
 * provider side rather than the JAXR client side. 
 *
 * @author Farrukh S. Najmi
 */
public class RegistryException extends JAXRException {
	private Key errorObjectKey; 
	
	 /**
     * Constructs a JAXRException object with no
     * reason or embedded Throwable.
     */
    public RegistryException() {
        super();
		this.cause = null;
    }

    /**
     * Constructs a JAXRException object with the given
     * String as the reason for the exception being thrown.
     *
     * @param reason a description of what caused the exception
     */
    public RegistryException(String reason) {
        super(reason);
		this.cause = null;
    }

    /**
     * Constructs a JAXRException object with the given
     * String as the reason for the exception being thrown
     * and the given Throwable object as an embedded
     * Throwable.
     *
     * @param reason a description of what caused the exception
     * @param cause a Throwable object that is to
     *        be embedded in this JAXRException object
     */
    public RegistryException(String reason, Throwable cause) {
       super (reason);
       initCause(cause);
    }

    /**
     * Constructs a JAXRException object initialized
     * with the given Throwable object.
     *
     * @param cause the Throwable that caused this Exception
     */
    public RegistryException(Throwable cause) {
		super (cause.toString());
		initCause(cause);
    }

    /**
     * Gets the Key to the first object that encountered an error in the registry.
     *
     * @return the key to the first object in error
     */
    public Key getErrorObjectKey() throws JAXRException {
		return errorObjectKey;
    }

    /**
     * Sets the Key to the first object that encountered an error in the registry.
     *
     * @param key	the key to the first object in error
     */
    public void setErrorObjectKey(Key key) throws JAXRException {
		errorObjectKey = key;
    }
}