FilerException.java revision 2571:10fc81ac75b4
1/*
2 * Copyright (c) 2005, 2012, 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 javax.annotation.processing;
27
28import java.io.IOException;
29
30/**
31 * Indicates a {@link Filer} detected an attempt to open a file that
32 * would violate the guarantees provided by the {@code Filer}.  Those
33 * guarantees include not creating the same file more than once, not
34 * creating multiple files corresponding to the same type, and not
35 * creating files for types with invalid names.
36 *
37 * @author Joseph D. Darcy
38 * @author Scott Seligman
39 * @author Peter von der Ahé
40 * @since 1.6
41 */
42public class FilerException extends IOException {
43    static final long serialVersionUID = 8426423106453163293L;
44    /**
45     * Constructs an exception with the specified detail message.
46     * @param s the detail message, which should include the name of
47     * the file attempting to be opened; may be {@code null}
48     */
49    public FilerException(String s) {
50        super(s);
51    }
52}
53