com.sun.mirror.type.MirroredTypeException Maven / Gradle / Ivy

/*
 * @(#)MirroredTypeException.java	1.1 04/04/20
 *
 * Copyright (c) 2004, Sun Microsystems, Inc.
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Sun Microsystems, Inc. nor the names of
 *       its contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.sun.mirror.type;


import java.lang.annotation.Annotation;

import com.sun.mirror.declaration.Declaration;


/**
 * Thrown when an application attempts to access the {@link Class} object
 * corresponding to a {@link TypeMirror}.
 *
 * @see MirroredTypesException
 * @see Declaration#getAnnotation(Class)
 */
public class MirroredTypeException extends RuntimeException {

	private static final long serialVersionUID = 1;

	private transient TypeMirror type;        // cannot be serialized
	private String name;            // type's qualified "name"

	/**
	 * Constructs a new MirroredTypeException for the specified type.
	 *
	 * @param type the type being accessed
	 */
	public MirroredTypeException(TypeMirror type) {
		super("Attempt to access Class object for TypeMirror " + type);
		this.type = type;
		name = type.toString();
	}

	/**
	 * Returns the type mirror corresponding to the type being accessed.
	 * The type mirror may be unavailable if this exception has been
	 * serialized and then read back in.
	 *
	 * @return the type mirror, or null if unavailable
	 */
	public TypeMirror getTypeMirror() {
		return type;
	}

	/**
	 * Returns the fully qualified name of the type being accessed.
	 * More precisely, returns the canonical name of a class,
	 * interface, array, or primitive, and returns "void" for
	 * the pseudo-type representing the type of void.
	 *
	 * @return the fully qualified name of the type being accessed
	 */
	public String getQualifiedName() {
		return name;
	}
}