langtools/src/share/classes/javax/lang/model/type/MirroredTypesException.java
author darcy
Tue, 11 Mar 2014 17:52:45 -0700
changeset 23394 45a10f396552
parent 22163 3651128c74eb
permissions -rw-r--r--
8037120: Fix doclint warnings in javax.lang.model exception types Reviewed-by: jjg
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
23394
45a10f396552 8037120: Fix doclint warnings in javax.lang.model exception types
darcy
parents: 22163
diff changeset
     2
 * Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1865
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1865
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    20
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1865
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1865
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1865
diff changeset
    23
 * questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
package javax.lang.model.type;
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
import java.util.ArrayList;
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
import java.util.List;
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
import java.util.Collections;
1865
aeefb02117a8 6583626: Improve serialization support in javax.lang.model.type exception classes
darcy
parents: 10
diff changeset
    31
import java.io.ObjectInputStream;
aeefb02117a8 6583626: Improve serialization support in javax.lang.model.type exception classes
darcy
parents: 10
diff changeset
    32
import java.io.IOException;
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
import javax.lang.model.element.Element;
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
 * Thrown when an application attempts to access a sequence of {@link
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
 * Class} objects each corresponding to a {@link TypeMirror}.
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
 * @author Joseph D. Darcy
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
 * @author Scott Seligman
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
 * @author Peter von der Ahé
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
 * @see MirroredTypeException
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
 * @see Element#getAnnotation(Class)
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
 * @since 1.6
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
public class MirroredTypesException extends RuntimeException {
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
    private static final long serialVersionUID = 269;
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
5843
e659a8974c9c 6519115: MirroredTypeException thrown but should be MirroredTypesException
darcy
parents: 5520
diff changeset
    51
    transient List<? extends TypeMirror> types; // cannot be serialized
e659a8974c9c 6519115: MirroredTypeException thrown but should be MirroredTypesException
darcy
parents: 5520
diff changeset
    52
e659a8974c9c 6519115: MirroredTypeException thrown but should be MirroredTypesException
darcy
parents: 5520
diff changeset
    53
    /*
e659a8974c9c 6519115: MirroredTypeException thrown but should be MirroredTypesException
darcy
parents: 5520
diff changeset
    54
     * Trusted constructor to be called by MirroredTypeException.
e659a8974c9c 6519115: MirroredTypeException thrown but should be MirroredTypesException
darcy
parents: 5520
diff changeset
    55
     */
e659a8974c9c 6519115: MirroredTypeException thrown but should be MirroredTypesException
darcy
parents: 5520
diff changeset
    56
    MirroredTypesException(String message, TypeMirror type) {
e659a8974c9c 6519115: MirroredTypeException thrown but should be MirroredTypesException
darcy
parents: 5520
diff changeset
    57
        super(message);
22163
3651128c74eb 8030244: Update langtools to use Diamond
briangoetz
parents: 14258
diff changeset
    58
        List<TypeMirror> tmp = (new ArrayList<>());
5843
e659a8974c9c 6519115: MirroredTypeException thrown but should be MirroredTypesException
darcy
parents: 5520
diff changeset
    59
        tmp.add(type);
e659a8974c9c 6519115: MirroredTypeException thrown but should be MirroredTypesException
darcy
parents: 5520
diff changeset
    60
        types = Collections.unmodifiableList(tmp);
e659a8974c9c 6519115: MirroredTypeException thrown but should be MirroredTypesException
darcy
parents: 5520
diff changeset
    61
    }
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
     * Constructs a new MirroredTypesException for the specified types.
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
     * @param types  the types being accessed
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
    public MirroredTypesException(List<? extends TypeMirror> types) {
1865
aeefb02117a8 6583626: Improve serialization support in javax.lang.model.type exception classes
darcy
parents: 10
diff changeset
    69
        super("Attempt to access Class objects for TypeMirrors " +
aeefb02117a8 6583626: Improve serialization support in javax.lang.model.type exception classes
darcy
parents: 10
diff changeset
    70
              (types = // defensive copy
22163
3651128c74eb 8030244: Update langtools to use Diamond
briangoetz
parents: 14258
diff changeset
    71
               new ArrayList<>(types)).toString() );
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
        this.types = Collections.unmodifiableList(types);
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
     * Returns the type mirrors corresponding to the types being accessed.
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
     * The type mirrors may be unavailable if this exception has been
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
     * serialized and then read back in.
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
     * @return the type mirrors in construction order, or {@code null} if unavailable
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
    public List<? extends TypeMirror> getTypeMirrors() {
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
        return types;
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
    }
1865
aeefb02117a8 6583626: Improve serialization support in javax.lang.model.type exception classes
darcy
parents: 10
diff changeset
    85
aeefb02117a8 6583626: Improve serialization support in javax.lang.model.type exception classes
darcy
parents: 10
diff changeset
    86
    /**
aeefb02117a8 6583626: Improve serialization support in javax.lang.model.type exception classes
darcy
parents: 10
diff changeset
    87
     * Explicitly set all transient fields.
23394
45a10f396552 8037120: Fix doclint warnings in javax.lang.model exception types
darcy
parents: 22163
diff changeset
    88
     * @param s the serial stream
45a10f396552 8037120: Fix doclint warnings in javax.lang.model exception types
darcy
parents: 22163
diff changeset
    89
     * @throws ClassNotFoundException for a missing class during
45a10f396552 8037120: Fix doclint warnings in javax.lang.model exception types
darcy
parents: 22163
diff changeset
    90
     * deserialization
45a10f396552 8037120: Fix doclint warnings in javax.lang.model exception types
darcy
parents: 22163
diff changeset
    91
     * @throws IOException for an IO problem during deserialization
1865
aeefb02117a8 6583626: Improve serialization support in javax.lang.model.type exception classes
darcy
parents: 10
diff changeset
    92
     */
aeefb02117a8 6583626: Improve serialization support in javax.lang.model.type exception classes
darcy
parents: 10
diff changeset
    93
    private void readObject(ObjectInputStream s)
aeefb02117a8 6583626: Improve serialization support in javax.lang.model.type exception classes
darcy
parents: 10
diff changeset
    94
        throws IOException, ClassNotFoundException {
aeefb02117a8 6583626: Improve serialization support in javax.lang.model.type exception classes
darcy
parents: 10
diff changeset
    95
        s.defaultReadObject();
aeefb02117a8 6583626: Improve serialization support in javax.lang.model.type exception classes
darcy
parents: 10
diff changeset
    96
        types = null;
aeefb02117a8 6583626: Improve serialization support in javax.lang.model.type exception classes
darcy
parents: 10
diff changeset
    97
    }
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
}