001/*
002 * Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.  Oracle designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Oracle in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
022 * or visit www.oracle.com if you need additional information or have any
023 * questions.
024 */
025
026package org.jdrupes.mdoclet.internal.doclets.toolkit.util;
027
028import java.io.IOException;
029
030import org.jdrupes.mdoclet.internal.doclets.toolkit.DocletException;
031
032/**
033 * Wraps an IOException and the path for the resource to which it applies.
034 *
035 * @apiNote This exception should be thrown by a doclet when an IO exception occurs
036 *  and the file is known that was in use when the exception occurred.
037 */
038public class ResourceIOException extends DocletException {
039
040    /**
041     * The resource that was in use when the exception occurred.
042     */
043    @SuppressWarnings("serial") // Type of field is not Serializable
044    public final DocPath resource;
045
046    private static final long serialVersionUID = 1L;
047
048    /**
049     * Creates an exception to wrap an IO exception, the resource which caused it.
050     *
051     * @param resource the resource in use when the exception occurred
052     * @param cause the underlying exception
053     */
054    public ResourceIOException(DocPath resource, IOException cause) {
055        super(resource.getPath(), cause);
056        this.resource = resource;
057    }
058}