A {@code URIReferenceException} can contain a cause: another + * throwable that caused this {@code URIReferenceException} to get thrown. + * + * @author Sean Mullan + * @author JSR 105 Expert Group + * @since 1.6 + * @see URIDereferencer#dereference(URIReference, XMLCryptoContext) + * @see RetrievalMethod#dereference(XMLCryptoContext) + */ +public class URIReferenceException extends Exception { + + private static final long serialVersionUID = 7173469703932561419L; + + /** + * 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; + + private URIReference uriReference; + + /** + * Constructs a new {@code URIReferenceException} with + * {@code null} as its detail message. + */ + public URIReferenceException() { + super(); + } + + /** + * Constructs a new {@code URIReferenceException} with the specified + * detail message. + * + * @param message the detail message + */ + public URIReferenceException(String message) { + super(message); + } + + /** + * Constructs a new {@code URIReferenceException} with the + * specified detail message and cause. + *
Note that the detail message associated with + * {@code cause} is not automatically incorporated in + * this exception's detail message. + * + * @param message the detail message + * @param cause the cause (A {@code null} value is permitted, and + * indicates that the cause is nonexistent or unknown.) + */ + public URIReferenceException(String message, Throwable cause) { + super(message); + this.cause = cause; + } + + /** + * Constructs a new {@code URIReferenceException} with the + * specified detail message, cause and {@code URIReference}. + *
Note that the detail message associated with + * {@code cause} is not automatically incorporated in + * this exception's detail message. + * + * @param message the detail message + * @param cause the cause (A {@code null} value is permitted, and + * indicates that the cause is nonexistent or unknown.) + * @param uriReference the {@code URIReference} that was being + * dereferenced when the error was encountered + * @throws NullPointerException if {@code uriReference} is + * {@code null} + */ + public URIReferenceException(String message, Throwable cause, + URIReference uriReference) { + this(message, cause); + if (uriReference == null) { + throw new NullPointerException("uriReference cannot be null"); + } + this.uriReference = uriReference; + } + + /** + * Constructs a new {@code URIReferenceException} with the specified + * cause and a detail message of {@code (cause==null ? null : + * cause.toString())} (which typically contains the class and detail + * message of {@code cause}). + * + * @param cause the cause (A {@code null} value is permitted, and + * indicates that the cause is nonexistent or unknown.) + */ + public URIReferenceException(Throwable cause) { + super(cause==null ? null : cause.toString()); + this.cause = cause; + } + + /** + * Returns the {@code URIReference} that was being dereferenced + * when the exception was thrown. + * + * @return the {@code URIReference} that was being dereferenced + * when the exception was thrown, or {@code null} if not specified + */ + public URIReference getURIReference() { + return uriReference; + } + + /** + * Returns the cause of this {@code URIReferenceException} or + * {@code null} if the cause is nonexistent or unknown. (The + * cause is the throwable that caused this + * {@code URIReferenceException} to get thrown.) + * + * @return the cause of this {@code URIReferenceException} or + * {@code null} if the cause is nonexistent or unknown. + */ + public Throwable getCause() { + return cause; + } + + /** + * Prints this {@code URIReferenceException}, its backtrace and + * the cause's backtrace to the standard error stream. + */ + public void printStackTrace() { + super.printStackTrace(); + //XXX print backtrace of cause + } + + /** + * Prints this {@code URIReferenceException}, its backtrace and + * the cause's backtrace to the specified print stream. + * + * @param s {@code PrintStream} to use for output + */ + public void printStackTrace(PrintStream s) { + super.printStackTrace(s); + //XXX print backtrace of cause + } + + /** + * Prints this {@code URIReferenceException}, its backtrace and + * the cause's backtrace to the specified print writer. + * + * @param s {@code PrintWriter} to use for output + */ + public void printStackTrace(PrintWriter s) { + super.printStackTrace(s); + //XXX print backtrace of cause + } +}