com.sun.javadoc.PackageDoc Maven / Gradle / Ivy
/*
* Copyright (c) 1998, 2018, Oracle and/or its affiliates. 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. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.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.
*
* 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)
*
* The declarations in this package have been superseded by those
* in the package {@code jdk.javadoc.doclet}.
* For more information, see the Migration Guide in the documentation for that package.
*/
@SuppressWarnings("removal")
public interface PackageDoc extends Doc {
/**
* Get all classes and interfaces in the package, filtered to the specified
* access
* modifier option.
*
* @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
* included
* classes and interfaces in the package. Same as allClasses(true).
*
* @return all included classes and interfaces in this package.
*/
ClassDoc[] allClasses();
/**
* Get included
* ordinary
* 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.
*
* @param className A String containing the name of the class to look up.
* @return ClassDoc of found class or interface,
* or null if not found.
*/
ClassDoc findClass(String className);
}