1 /*

     2  * Copyright (c) 2004, 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 

    26 package com.sun.mirror.declaration;

    27 

    28 

    29 import java.util.Collection;

    30 

    31 

    32 /**

    33  * Represents the declaration of a package.  Provides access to information

    34  * about the package and its members.

    35  *

    36  * <p> {@link com.sun.mirror.util.DeclarationFilter}

    37  * provides a simple way to select just the items of interest

    38  * when a method returns a collection of declarations.

    39  *

    40  * @deprecated All components of this API have been superseded by the

    41  * standardized annotation processing API.  The replacement for the

    42  * functionality of this interface is {@link

    43  * javax.lang.model.element.PackageElement}.

    44  *

    45  * @author Joseph D. Darcy

    46  * @author Scott Seligman

    47  * @since 1.5

    48  */

    49 @Deprecated

    50 @SuppressWarnings("deprecation")

    51 public interface PackageDeclaration extends Declaration {

    52 

    53     /**

    54      * Returns the fully qualified name of this package.

    55      * This is also known as the package's <i>canonical</i> name.

    56      *

    57      * @return the fully qualified name of this package, or the

    58      * empty string if this is the unnamed package

    59      */

    60     String getQualifiedName();

    61 

    62     /**

    63      * Returns the declarations of the top-level classes in this package.

    64      * Interfaces are not included, but enum types are.

    65      *

    66      * @return the declarations of the top-level classes in this package

    67      *

    68      * @see com.sun.mirror.util.DeclarationFilter

    69      */

    70     Collection<ClassDeclaration> getClasses();

    71 

    72     /**

    73      * Returns the declarations of the top-level enum types in this package.

    74      *

    75      * @return the declarations of the top-level enum types in this package

    76      *

    77      * @see com.sun.mirror.util.DeclarationFilter

    78      */

    79     Collection<EnumDeclaration> getEnums();

    80 

    81     /**

    82      * Returns the declarations of the top-level interfaces in this package.

    83      * Annotation types are included.

    84      *

    85      * @return the declarations of the top-level interfaces in this package

    86      *

    87      * @see com.sun.mirror.util.DeclarationFilter

    88      */

    89     Collection<InterfaceDeclaration> getInterfaces();

    90 

    91     /**

    92      * Returns the declarations of the top-level annotation types in this

    93      * package.

    94      *

    95      * @return the declarations of the top-level annotation types in this

    96      * package

    97      *

    98      * @see com.sun.mirror.util.DeclarationFilter

    99      */

   100     Collection<AnnotationTypeDeclaration> getAnnotationTypes();

   101 }