You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
130 lines
3.1 KiB
130 lines
3.1 KiB
/*
|
|
* Copyright (c) 1998, 2006, Oracle and/or its affiliates. All rights reserved.
|
|
* ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*/
|
|
|
|
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);
|
|
}
|