1 /*

     2  * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    25 

    26 package jdk.javadoc.internal.doclets.toolkit.util;

    27 

    28 import java.io.IOException;

    29 

    30 import jdk.javadoc.internal.doclets.toolkit.DocletException;

    31 

    32 

    33 /**

    34  * Wraps an IOException and the filename to which it applies.

    35  *

    36  * <p><b>This is NOT part of any supported API.

    37  * If you write code that depends on this, you do so at your own risk.

    38  * This code and its internal interfaces are subject to change or

    39  * deletion without notice.</b>

    40  *

    41  * @apiNote This exception should be thrown by a doclet when an IO exception occurs

    42  *  and the file is known that was in use when the exception occurred.

    43  */

    44 public class DocFileIOException extends DocletException {

    45     /**

    46      * A hint for the type of operation being performed when the exception occurred.

    47      *

    48      * @apiNote This may be used as a hint when reporting a message to the end user.

    49      */

    50     public enum Mode {

    51         /** The file was being opened for reading, or being read when the exception occurred. */

    52         READ,

    53         /** The file was being opened for writing, or being written when the exception occurred. */

    54         WRITE

    55     };

    56 

    57     /**

    58      * The file that was in use when the exception occurred.

    59      */

    60     public final DocFile fileName;

    61 

    62     /**

    63      * The mode in which the file was being used when the exception occurred.

    64      */

    65     public final Mode mode;

    66 

    67     private static final long serialVersionUID = 1L;

    68 

    69     /**

    70      * Creates an exception to wrap an IO exception, the file which caused it, and the manner

    71      * in which the file was being used.

    72      *

    73      * @param fileName the file in use when the exception occurred

    74      * @param mode the manner in which the file was being used

    75      * @param cause the underlying exception

    76      */

    77     public DocFileIOException(DocFile fileName, Mode mode, IOException cause) {

    78         super(mode + ":" + fileName.getPath(), cause);

    79         this.fileName = fileName;

    80         this.mode = mode;

    81     }

    82 }