• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/javadoc/PackageDoc.java@2eb010b6cb22 (annotated)

src/share/classes/com/sun/javadoc/PackageDoc.java

Thu, 31 Aug 2017 15:17:03 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:17:03 +0800

changeset 2525

2eb010b6cb22

parent 554

9d9f26857129

parent 0

959103a6100f

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1998, 2006, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.javadoc;
aoqi@0	27
aoqi@0	28	/**
aoqi@0	29	* Represents a java package. Provides access to information
aoqi@0	30	* about the package, the package's comment and tags, and the
aoqi@0	31	* classes in the package.
aoqi@0	32	* <p>
aoqi@0	33	* Each method whose return type is an array will return an empty
aoqi@0	34	* array (never null) when there are no objects in the result.
aoqi@0	35	*
aoqi@0	36	* @since 1.2
aoqi@0	37	* @author Kaiyang Liu (original)
aoqi@0	38	* @author Robert Field (rewrite)
aoqi@0	39	*/
aoqi@0	40	public interface PackageDoc extends Doc {
aoqi@0	41
aoqi@0	42	/**
aoqi@0	43	* Get all classes and interfaces in the package, filtered to the specified
aoqi@0	44	* <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">access
aoqi@0	45	* modifier option</a>.
aoqi@0	46	*
aoqi@0	47	* @return filtered classes and interfaces in this package
aoqi@0	48	* @param filter Specifying true filters according to the specified access
aoqi@0	49	* modifier option.
aoqi@0	50	* Specifying false includes all classes and interfaces
aoqi@0	51	* regardless of access modifier option.
aoqi@0	52	* @since 1.4
aoqi@0	53	*/
aoqi@0	54	ClassDoc[] allClasses(boolean filter);
aoqi@0	55
aoqi@0	56	/**
aoqi@0	57	* Get all
aoqi@0	58	* <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">included</a>
aoqi@0	59	* classes and interfaces in the package. Same as allClasses(true).
aoqi@0	60	*
aoqi@0	61	* @return all included classes and interfaces in this package.
aoqi@0	62	*/
aoqi@0	63	ClassDoc[] allClasses();
aoqi@0	64
aoqi@0	65	/**
aoqi@0	66	* Get included
aoqi@0	67	* <a href="{@docRoot}/com/sun/javadoc/package-summary.html#class">ordinary</a>
aoqi@0	68	* classes (that is, exclude exceptions, errors, enums, interfaces, and
aoqi@0	69	* annotation types)
aoqi@0	70	* in this package.
aoqi@0	71	*
aoqi@0	72	* @return included ordinary classes in this package.
aoqi@0	73	*/
aoqi@0	74	ClassDoc[] ordinaryClasses();
aoqi@0	75
aoqi@0	76	/**
aoqi@0	77	* Get included Exception classes in this package.
aoqi@0	78	*
aoqi@0	79	* @return included Exceptions in this package.
aoqi@0	80	*/
aoqi@0	81	ClassDoc[] exceptions();
aoqi@0	82
aoqi@0	83	/**
aoqi@0	84	* Get included Error classes in this package.
aoqi@0	85	*
aoqi@0	86	* @return included Errors in this package.
aoqi@0	87	*/
aoqi@0	88	ClassDoc[] errors();
aoqi@0	89
aoqi@0	90	/**
aoqi@0	91	* Get included enum types in this package.
aoqi@0	92	*
aoqi@0	93	* @return included enum types in this package.
aoqi@0	94	* @since 1.5
aoqi@0	95	*/
aoqi@0	96	ClassDoc[] enums();
aoqi@0	97
aoqi@0	98	/**
aoqi@0	99	* Get included interfaces in this package, omitting annotation types.
aoqi@0	100	*
aoqi@0	101	* @return included interfaces in this package.
aoqi@0	102	*/
aoqi@0	103	ClassDoc[] interfaces();
aoqi@0	104
aoqi@0	105	/**
aoqi@0	106	* Get included annotation types in this package.
aoqi@0	107	*
aoqi@0	108	* @return included annotation types in this package.
aoqi@0	109	* @since 1.5
aoqi@0	110	*/
aoqi@0	111	AnnotationTypeDoc[] annotationTypes();
aoqi@0	112
aoqi@0	113	/**
aoqi@0	114	* Get the annotations of this package.
aoqi@0	115	* Return an empty array if there are none.
aoqi@0	116	*
aoqi@0	117	* @return the annotations of this package.
aoqi@0	118	* @since 1.5
aoqi@0	119	*/
aoqi@0	120	AnnotationDesc[] annotations();
aoqi@0	121
aoqi@0	122	/**
aoqi@0	123	* Lookup a class or interface within this package.
aoqi@0	124	*
aoqi@0	125	* @return ClassDoc of found class or interface,
aoqi@0	126	* or null if not found.
aoqi@0	127	*/
aoqi@0	128	ClassDoc findClass(String className);
aoqi@0	129	}