/* * Copyright 2004 Sun Microsystems, Inc. All Rights Reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Sun designates this * particular file as subject to the "Classpath" exception as provided * by Sun in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, * CA 95054 USA or visit www.sun.com if you need additional information or * have any questions. */ package com.sun.mirror.declaration; import java.util.Collection; import com.sun.mirror.type.*; /** * Represents the declaration of a class or interface. * Provides access to information about the type and its members. * Note that an {@linkplain EnumDeclaration enum} is a kind of class, * and an {@linkplain AnnotationTypeDeclaration annotation type} is * a kind of interface. * *
* While a TypeDeclaration represents the declaration
* of a class or interface, a {@link DeclaredType} represents a class
* or interface type, the latter being a use
* (or invocation) of the former.
* The distinction is most apparent with generic types,
* for which a single declaration can define a whole
* family of types. For example, the declaration of
* {@code java.util.Set} corresponds to the parameterized types
* {@code java.util.Set {@link com.sun.mirror.util.DeclarationFilter}
* provides a simple way to select just the items of interest
* when a method returns a collection of declarations.
*
* @deprecated All components of this API have been superseded by the
* standardized annotation processing API. The replacement for the
* functionality of this interface is included in {@link
* javax.lang.model.element.TypeElement}.
*
* @author Joseph D. Darcy
* @author Scott Seligman
*
* @see DeclaredType
* @since 1.5
*/
@Deprecated
@SuppressWarnings("deprecation")
public interface TypeDeclaration extends MemberDeclaration {
/**
* Returns the package within which this type is declared.
*
* @return the package within which this type is declared
*/
PackageDeclaration getPackage();
/**
* Returns the fully qualified name of this class or interface
* declaration. More precisely, it returns the canonical
* name.
* The name of a generic type does not include any reference
* to its formal type parameters.
* For example, the the fully qualified name of the interface declaration
* {@code java.util.Set