javax.xml.crypto.MarshalException Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/*
* Copyright 2005 Sun Microsystems, Inc. All rights reserved.
*/
/*
* $Id: MarshalException.java 1536468 2013-10-28 18:24:28Z mullan $
*/
package javax.xml.crypto;
import java.io.PrintStream;
import java.io.PrintWriter;
import javax.xml.crypto.dsig.XMLSignature;
import javax.xml.crypto.dsig.XMLSignatureFactory;
/**
* Indicates an exceptional condition that occurred during the XML
* marshalling or unmarshalling process.
*
* A MarshalException can contain a cause: another
* throwable that caused this MarshalException to get thrown.
*
* @author Sean Mullan
* @author JSR 105 Expert Group
* @see XMLSignature#sign(XMLSignContext)
* @see XMLSignatureFactory#unmarshalXMLSignature(XMLValidateContext)
*/
public class MarshalException extends Exception {
private static final long serialVersionUID = -863185580332643547L;
/**
* The throwable that caused this exception to get thrown, or null if this
* exception was not caused by another throwable or if the causative
* throwable is unknown.
*
* @serial
*/
private Throwable cause;
/**
* Constructs a new MarshalException with
* null as its detail message.
*/
public MarshalException() {
super();
}
/**
* Constructs a new MarshalException with the specified
* detail message.
*
* @param message the detail message
*/
public MarshalException(String message) {
super(message);
}
/**
* Constructs a new MarshalException with the
* specified detail message and cause.
*
Note that the detail message associated with
* cause is not automatically incorporated in
* this exception's detail message.
*
* @param message the detail message
* @param cause the cause (A null value is permitted, and
* indicates that the cause is nonexistent or unknown.)
*/
public MarshalException(String message, Throwable cause) {
super(message);
this.cause = cause;
}
/**
* Constructs a new MarshalException with the specified cause
* and a detail message of (cause==null ? null : cause.toString())
* (which typically contains the class and detail message of
* cause).
*
* @param cause the cause (A null value is permitted, and
* indicates that the cause is nonexistent or unknown.)
*/
public MarshalException(Throwable cause) {
super(cause == null ? null : cause.toString());
this.cause = cause;
}
/**
* Returns the cause of this MarshalException or
* null if the cause is nonexistent or unknown. (The
* cause is the throwable that caused this
* MarshalException to get thrown.)
*
* @return the cause of this MarshalException or
* null if the cause is nonexistent or unknown.
*/
public Throwable getCause() {
return cause;
}
/**
* Prints this MarshalException, its backtrace and
* the cause's backtrace to the standard error stream.
*/
public void printStackTrace() {
super.printStackTrace();
cause.printStackTrace();
}
/**
* Prints this MarshalException, its backtrace and
* the cause's backtrace to the specified print stream.
*
* @param s PrintStream to use for output
*/
public void printStackTrace(PrintStream s) {
super.printStackTrace(s);
cause.printStackTrace(s);
}
/**
* Prints this MarshalException, its backtrace and
* the cause's backtrace to the specified print writer.
*
* @param s PrintWriter to use for output
*/
public void printStackTrace(PrintWriter s) {
super.printStackTrace(s);
cause.printStackTrace(s);
}
}