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 26package jdk.javadoc.internal.doclets.toolkit.util; 27 28import java.io.IOException; 29 30import jdk.javadoc.internal.doclets.toolkit.DocletException; 31 32 33/** 34 * Wraps an IOException and the path for the resource 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 */ 44public class ResourceIOException extends DocletException { 45 46 /** 47 * The resource that was in use when the exception occurred. 48 */ 49 public final DocPath resource; 50 51 private static final long serialVersionUID = 1L; 52 53 /** 54 * Creates an exception to wrap an IO exception, the resource which caused it. 55 * 56 * @param resource the resource in use when the exception occurred 57 * @param cause the underlying exception 58 */ 59 public ResourceIOException(DocPath resource, IOException cause) { 60 super(resource.getPath(), cause); 61 this.resource = resource; 62 } 63} 64