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 filename 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 DocFileIOException extends DocletException {
039    /**
040     * A hint for the type of operation being performed when the exception occurred.
041     *
042     * @apiNote This may be used as a hint when reporting a message to the end user.
043     */
044    public enum Mode {
045        /** The file was being opened for reading, or being read when the exception occurred. */
046        READ,
047        /** The file was being opened for writing, or being written when the exception occurred. */
048        WRITE
049    }
050
051    /**
052     * The file that was in use when the exception occurred.
053     */
054    @SuppressWarnings("serial") // Type of field is not Serializable
055    public final DocFile fileName;
056
057    /**
058     * The mode in which the file was being used when the exception occurred.
059     */
060    public final Mode mode;
061
062    private static final long serialVersionUID = 1L;
063
064    /**
065     * Creates an exception to wrap an IO exception, the file which caused it, and the manner
066     * in which the file was being used.
067     *
068     * @param fileName the file in use when the exception occurred
069     * @param mode the manner in which the file was being used
070     * @param cause the underlying exception
071     */
072    public DocFileIOException(DocFile fileName, Mode mode, IOException cause) {
073        super(mode + ":" + fileName.getPath(), cause);
074        this.fileName = fileName;
075        this.mode = mode;
076    }
077}