0N/A/*
553N/A * Copyright (c) 1998, 2006, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
553N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
553N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
553N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
553N/A * or visit www.oracle.com if you need additional information or have any
553N/A * questions.
0N/A */
0N/A
0N/Apackage com.sun.javadoc;
0N/A
0N/A/**
0N/A * Represents a java package. Provides access to information
0N/A * about the package, the package's comment and tags, and the
0N/A * classes in the package.
0N/A * <p>
0N/A * Each method whose return type is an array will return an empty
0N/A * array (never null) when there are no objects in the result.
0N/A *
0N/A * @since 1.2
0N/A * @author Kaiyang Liu (original)
0N/A * @author Robert Field (rewrite)
0N/A */
0N/Apublic interface PackageDoc extends Doc {
0N/A
0N/A /**
0N/A * Get all classes and interfaces in the package, filtered to the specified
0N/A * <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">access
0N/A * modifier option</a>.
0N/A *
0N/A * @return filtered classes and interfaces in this package
0N/A * @param filter Specifying true filters according to the specified access
0N/A * modifier option.
0N/A * Specifying false includes all classes and interfaces
0N/A * regardless of access modifier option.
0N/A * @since 1.4
0N/A */
0N/A ClassDoc[] allClasses(boolean filter);
0N/A
0N/A /**
0N/A * Get all
0N/A * <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">included</a>
0N/A * classes and interfaces in the package. Same as allClasses(true).
0N/A *
0N/A * @return all included classes and interfaces in this package.
0N/A */
0N/A ClassDoc[] allClasses();
0N/A
0N/A /**
0N/A * Get included
0N/A * <a href="{@docRoot}/com/sun/javadoc/package-summary.html#class">ordinary</a>
0N/A * classes (that is, exclude exceptions, errors, enums, interfaces, and
0N/A * annotation types)
0N/A * in this package.
0N/A *
0N/A * @return included ordinary classes in this package.
0N/A */
0N/A ClassDoc[] ordinaryClasses();
0N/A
0N/A /**
0N/A * Get included Exception classes in this package.
0N/A *
0N/A * @return included Exceptions in this package.
0N/A */
0N/A ClassDoc[] exceptions();
0N/A
0N/A /**
0N/A * Get included Error classes in this package.
0N/A *
0N/A * @return included Errors in this package.
0N/A */
0N/A ClassDoc[] errors();
0N/A
0N/A /**
0N/A * Get included enum types in this package.
0N/A *
0N/A * @return included enum types in this package.
0N/A * @since 1.5
0N/A */
0N/A ClassDoc[] enums();
0N/A
0N/A /**
0N/A * Get included interfaces in this package, omitting annotation types.
0N/A *
0N/A * @return included interfaces in this package.
0N/A */
0N/A ClassDoc[] interfaces();
0N/A
0N/A /**
0N/A * Get included annotation types in this package.
0N/A *
0N/A * @return included annotation types in this package.
0N/A * @since 1.5
0N/A */
0N/A AnnotationTypeDoc[] annotationTypes();
0N/A
0N/A /**
0N/A * Get the annotations of this package.
0N/A * Return an empty array if there are none.
0N/A *
0N/A * @return the annotations of this package.
0N/A * @since 1.5
0N/A */
0N/A AnnotationDesc[] annotations();
0N/A
0N/A /**
0N/A * Lookup a class or interface within this package.
0N/A *
0N/A * @return ClassDoc of found class or interface,
0N/A * or null if not found.
0N/A */
0N/A ClassDoc findClass(String className);
0N/A}