MirroredTypesException.java revision 2571:10fc81ac75b4
1/*
2 * Copyright (c) 2005, 2014, 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.lang.model.type;
27
28import java.util.ArrayList;
29import java.util.List;
30import java.util.Collections;
31import java.io.ObjectInputStream;
32import java.io.IOException;
33import javax.lang.model.element.Element;
34
35
36/**
37 * Thrown when an application attempts to access a sequence of {@link
38 * Class} objects each corresponding to a {@link TypeMirror}.
39 *
40 * @author Joseph D. Darcy
41 * @author Scott Seligman
42 * @author Peter von der Ahé
43 * @see MirroredTypeException
44 * @see Element#getAnnotation(Class)
45 * @since 1.6
46 */
47public class MirroredTypesException extends RuntimeException {
48
49    private static final long serialVersionUID = 269;
50
51    transient List<? extends TypeMirror> types; // cannot be serialized
52
53    /*
54     * Trusted constructor to be called by MirroredTypeException.
55     */
56    MirroredTypesException(String message, TypeMirror type) {
57        super(message);
58        List<TypeMirror> tmp = (new ArrayList<>());
59        tmp.add(type);
60        types = Collections.unmodifiableList(tmp);
61    }
62
63    /**
64     * Constructs a new MirroredTypesException for the specified types.
65     *
66     * @param types  the types being accessed
67     */
68    public MirroredTypesException(List<? extends TypeMirror> types) {
69        super("Attempt to access Class objects for TypeMirrors " +
70              (types = // defensive copy
71               new ArrayList<>(types)).toString() );
72        this.types = Collections.unmodifiableList(types);
73    }
74
75    /**
76     * Returns the type mirrors corresponding to the types being accessed.
77     * The type mirrors may be unavailable if this exception has been
78     * serialized and then read back in.
79     *
80     * @return the type mirrors in construction order, or {@code null} if unavailable
81     */
82    public List<? extends TypeMirror> getTypeMirrors() {
83        return types;
84    }
85
86    /**
87     * Explicitly set all transient fields.
88     * @param s the serial stream
89     * @throws ClassNotFoundException for a missing class during
90     * deserialization
91     * @throws IOException for an IO problem during deserialization
92     */
93    private void readObject(ObjectInputStream s)
94        throws IOException, ClassNotFoundException {
95        s.defaultReadObject();
96        types = null;
97    }
98}
99