| /* |
| * Copyright 1998-2006 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.javadoc; |
| |
| /** |
| * Represents a java package. Provides access to information |
| * about the package, the package's comment and tags, and the |
| * classes in the package. |
| * <p> |
| * Each method whose return type is an array will return an empty |
| * array (never null) when there are no objects in the result. |
| * |
| * @since 1.2 |
| * @author Kaiyang Liu (original) |
| * @author Robert Field (rewrite) |
| */ |
| public interface PackageDoc extends Doc { |
| |
| /** |
| * Get all classes and interfaces in the package, filtered to the specified |
| * <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">access |
| * modifier option</a>. |
| * |
| * @return filtered classes and interfaces in this package |
| * @param filter Specifying true filters according to the specified access |
| * modifier option. |
| * Specifying false includes all classes and interfaces |
| * regardless of access modifier option. |
| * @since 1.4 |
| */ |
| ClassDoc[] allClasses(boolean filter); |
| |
| /** |
| * Get all |
| * <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">included</a> |
| * classes and interfaces in the package. Same as allClasses(true). |
| * |
| * @return all included classes and interfaces in this package. |
| */ |
| ClassDoc[] allClasses(); |
| |
| /** |
| * Get included |
| * <a href="{@docRoot}/com/sun/javadoc/package-summary.html#class">ordinary</a> |
| * classes (that is, exclude exceptions, errors, enums, interfaces, and |
| * annotation types) |
| * in this package. |
| * |
| * @return included ordinary classes in this package. |
| */ |
| ClassDoc[] ordinaryClasses(); |
| |
| /** |
| * Get included Exception classes in this package. |
| * |
| * @return included Exceptions in this package. |
| */ |
| ClassDoc[] exceptions(); |
| |
| /** |
| * Get included Error classes in this package. |
| * |
| * @return included Errors in this package. |
| */ |
| ClassDoc[] errors(); |
| |
| /** |
| * Get included enum types in this package. |
| * |
| * @return included enum types in this package. |
| * @since 1.5 |
| */ |
| ClassDoc[] enums(); |
| |
| /** |
| * Get included interfaces in this package, omitting annotation types. |
| * |
| * @return included interfaces in this package. |
| */ |
| ClassDoc[] interfaces(); |
| |
| /** |
| * Get included annotation types in this package. |
| * |
| * @return included annotation types in this package. |
| * @since 1.5 |
| */ |
| AnnotationTypeDoc[] annotationTypes(); |
| |
| /** |
| * Get the annotations of this package. |
| * Return an empty array if there are none. |
| * |
| * @return the annotations of this package. |
| * @since 1.5 |
| */ |
| AnnotationDesc[] annotations(); |
| |
| /** |
| * Lookup a class or interface within this package. |
| * |
| * @return ClassDoc of found class or interface, |
| * or null if not found. |
| */ |
| ClassDoc findClass(String className); |
| } |